Create Permanent Supporting Document#
Creates a permanent supporting document.
Request#
HTTP Method: POST
URI Path: /v3/permanent_supporting_documents
Request Body Object Attributes#
Name |
Type |
Is Required? |
Description |
|---|---|---|---|
external_reference_id |
|
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 |
|
Yes |
The IDs of the encrypted files. From 1 to 5 files: more than 5 returns |
template |
|
Yes |
The ID of supporting documents. |
identity |
|
Yes |
The ID of identity. |
Examples#
http
1POST /v3/permanent_supporting_documents HTTP/1.1
2Host: api.didww.com
3Content-Type: application/vnd.api+json
4Accept: application/vnd.api+json
5Authorization: Bearer [access 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://api.didww.com/v3/permanent_supporting_documents -H "Accept: application/vnd.api+json" -H "Content-Type: application/vnd.api+json" -H "Authorization: Bearer [access token]" --data-raw '{"data": {"relationships": {"files": {"data": [{"id": "94ec30ef-9f9c-49d6-97a9-d76e93b818c5", "type": "encrypted_files"}]}, "identity": {"data": {"id": "01798514-ccf8-495b-b4ee-01b91c533e53", "type": "identities"}}, "template": {"data": {"id": "47051582-bbe6-4d68-95f5-d7322bbaa74e", "type": "supporting_document_templates"}}}, "type": "permanent_supporting_documents"}}'
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://api.didww.com/v3/permanent_supporting_documents/d1a1a686-969a-4c02-954c-ae500ba74a1d/relationships/template",
16 "related": "https://api.didww.com/v3/permanent_supporting_documents/d1a1a686-969a-4c02-954c-ae500ba74a1d/template"
17 }
18 },
19 "identity": {
20 "links": {
21 "self": "https://api.didww.com/v3/permanent_supporting_documents/d1a1a686-969a-4c02-954c-ae500ba74a1d/relationships/identity",
22 "related": "https://api.didww.com/v3/permanent_supporting_documents/d1a1a686-969a-4c02-954c-ae500ba74a1d/identity"
23 }
24 }
25 }
26 },
27 "meta": {
28 "api_version": "2026-11-19"
29 }
30}
Other Responses#
Code |
Success |
Description |
|---|---|---|
400 |
No |
Bad Request. The body carries a member the API does not accept. |
401 |
No |
|
403 |
No |
The access token carries the |
422 |
No |
Validation error. The document was rejected. |
429 |
No |
The request budget of the account for the current window is spent ( |