Create Permanent Supporting Document
POST https://{{host}}/v3/permanent_supporting_documents
Creates a permanent supporting document.
Request Body Scheme
{
data (object, required)
{
type (string, required): permanentsupportingdocuments
relationships (object, required){
files (object, required): to-many
The IDs of Encrypted Files.template (object, required): to-one
The ID of Supporting Document Template.
}
}
}
Request Body Example
{
"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"
}
}
}
}
}
HEADERS
Key | Datatype | Required | Description |
---|---|---|---|
Accept | string | ||
Content-Type | string | ||
Api-Key | string |
RESPONSES
status: Created
{"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://api.didww.com/v3/permanent_supporting_documents/d1a1a686-969a-4c02-954c-ae500ba74a1d/relationships/template","related":"https://api.didww.com/v3/permanent_supporting_documents/d1a1a686-969a-4c02-954c-ae500ba74a1d/template"}},"identity":{"links":{"self":"https://api.didww.com/v3/permanent_supporting_documents/d1a1a686-969a-4c02-954c-ae500ba74a1d/relationships/identity","related":"https://api.didww.com/v3/permanent_supporting_documents/d1a1a686-969a-4c02-954c-ae500ba74a1d/identity"}}}},"meta":{"api_version":"2021-04-19"}}