Create Permanent Supporting Document#

Creates a permanent supporting document.

Request#

HTTP Method: POST

URI Path: /v3/permanent_supporting_documents

URI Query Parameters#

Request Body Object Attributes#

Name

Type

Is Required?

Description

external_reference_id

string

No

Optional identifier for the permanent supporting document in the customer’s external system. Maximum length is 100 characters.

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#

http

 1POST /v3/permanent_supporting_documents HTTP/1.1
 2    Host: api.didww.com
 3    Content-Type: application/vnd.api+json
 4    Accept: application/vnd.api+json
 5    Api-Key: [API token]
 6
 7    {
 8      "data": {
 9        "type": "permanent_supporting_documents",
10        "relationships": {
11          "files": {
12            "data": [
13              {
14                "id": "94ec30ef-9f9c-49d6-97a9-d76e93b818c5",
15                "type": "encrypted_files"
16              }
17            ]
18          },
19          "template": {
20            "data": {
21              "id": "47051582-bbe6-4d68-95f5-d7322bbaa74e",
22              "type": "supporting_document_templates"
23            }
24          },
25          "identity": {
26            "data": {
27              "id": "01798514-ccf8-495b-b4ee-01b91c533e53",
28              "type": "identities"
29            }
30          }
31        }
32      }
33    }

curl

 1curl -i -X POST https://nohost/v3/permanent_supporting_documents --data-raw '{
 2
 3      "data": {
 4
 5        "type": "permanent_supporting_documents",
 6
 7        "relationships": {
 8
 9          "files": {
10
11            "data": [
12
13              {
14
15                "id": "94ec30ef-9f9c-49d6-97a9-d76e93b818c5",
16
17                "type": "encrypted_files"
18
19              }
20
21            ]
22
23          },
24
25          "template": {
26
27            "data": {
28
29              "id": "47051582-bbe6-4d68-95f5-d7322bbaa74e",
30
31              "type": "supporting_document_templates"
32
33            }
34
35          },
36
37          "identity": {
38
39            "data": {
40
41              "id": "01798514-ccf8-495b-b4ee-01b91c533e53",
42
43              "type": "identities"
44
45            }
46
47          }
48
49        }
50
51      }
52
53    }'

response

 1HTTP/1.1 201 Created
 2Content-Type: application/vnd.api+json
 3
 4    {
 5        "data": {
 6            "id": "d1a1a686-969a-4c02-954c-ae500ba74a1d",
 7            "type": "permanent_supporting_documents",
 8            "attributes": {
 9                "created_at": "2021-03-28T18:51:59.590Z",
10                "external_reference_id": null
11            },
12            "relationships": {
13                "template": {
14                    "links": {
15                        "self": "https://sandbox-api.didww.com/v3/permanent_supporting_documents/d1a1a686-969a-4c02-954c-ae500ba74a1d/relationships/template",
16                        "related": "https://sandbox-api.didww.com/v3/permanent_supporting_documents/d1a1a686-969a-4c02-954c-ae500ba74a1d/template"
17                    }
18                },
19                "identity": {
20                    "links": {
21                        "self": "https://sandbox-api.didww.com/v3/permanent_supporting_documents/d1a1a686-969a-4c02-954c-ae500ba74a1d/relationships/identity",
22                        "related": "https://sandbox-api.didww.com/v3/permanent_supporting_documents/d1a1a686-969a-4c02-954c-ae500ba74a1d/identity"
23                    }
24                }
25            }
26        },
27        "meta": {
28            "api_version": "2026-04-16"
29        }
30    }

Other Responses#

Code

Success

Description

401

No

Unauthorized