Create Permanent Supporting Document

Description

Creates a permanent supporting document.

Request

HTTP Method: POST

URI Path: /v3/permanent_supporting_documents

URI Query Parameters:

Request Body Object Relationship:

Name	Type	Is Required?	Description
files	string	Yes	The ID of encrypted files.
template	string	Yes	The ID of supporting documents.
identity	string	Yes	The ID of identity.

Examples

Example

http

POST /v3/permanent_supporting_documents HTTP/1.1
    Host: api.didww.com
    Content-Type: application/vnd.api+json
    Accept: application/vnd.api+json
    Api-Key: [API token]

    {
      "data": {
        "type": "permanent_supporting_documents",
        "relationships": {
          "files": {
            "data": [
              {
                "id": "94ec30ef-9f9c-49d6-97a9-d76e93b818c5",
                "type": "encrypted_files"
              }
            ]
          },
          "template": {
            "data": {
              "id": "47051582-bbe6-4d68-95f5-d7322bbaa74e",
              "type": "supporting_document_templates"
            }
          },
          "identity": {
            "data": {
              "id": "01798514-ccf8-495b-b4ee-01b91c533e53",
              "type": "identities"
            }
          }
        }
      }
    }

curl

curl -i -X POST https://nohost/v3/permanent_supporting_documents --data-raw '{

      "data": {

        "type": "permanent_supporting_documents",

        "relationships": {

          "files": {

            "data": [

              {

                "id": "94ec30ef-9f9c-49d6-97a9-d76e93b818c5",

                "type": "encrypted_files"

              }

            ]

          },

          "template": {

            "data": {

              "id": "47051582-bbe6-4d68-95f5-d7322bbaa74e",

              "type": "supporting_document_templates"

            }

          },

          "identity": {

            "data": {

              "id": "01798514-ccf8-495b-b4ee-01b91c533e53",

              "type": "identities"

            }

          }

        }

      }

    }'

response

HTTP/1.1 201 Created
Content-Type: application/vnd.api+json

    {
        "data": {
            "id": "d1a1a686-969a-4c02-954c-ae500ba74a1d",
            "type": "permanent_supporting_documents",
            "attributes": {
                "created_at": "2021-03-28T18:51:59.590Z"
            },
            "relationships": {
                "template": {
                    "links": {
                        "self": "https://sandbox-api.didww.com/v3/permanent_supporting_documents/d1a1a686-969a-4c02-954c-ae500ba74a1d/relationships/template",
                        "related": "https://sandbox-api.didww.com/v3/permanent_supporting_documents/d1a1a686-969a-4c02-954c-ae500ba74a1d/template"
                    }
                },
                "identity": {
                    "links": {
                        "self": "https://sandbox-api.didww.com/v3/permanent_supporting_documents/d1a1a686-969a-4c02-954c-ae500ba74a1d/relationships/identity",
                        "related": "https://sandbox-api.didww.com/v3/permanent_supporting_documents/d1a1a686-969a-4c02-954c-ae500ba74a1d/identity"
                    }
                }
            }
        },
        "meta": {
            "api_version": "2022-05-10"
        }
    }

Other Responses

Code	Success	Description
401	No	Unauthorized