Get Permanent Supporting Document#

Returns a single permanent supporting document in the account.

Request#

HTTP Method: GET

URI Path: /v3/permanent_supporting_documents/{id}

Note

For all returned data attributes, see Permanent Supporting Documents Object.

URI Query Parameters#

Name

Type

Is Required?

Description

id

string

Yes

Unique ID identifier of the permanent supporting document.

include

string

No

Related resources to include in the response. See Inclusion.

Includes#

Value

Description

template

Supporting Document Template Object

identity

Identity Object

Examples#

http

1GET /v3/permanent_supporting_documents/d1a1a686-969a-4c02-954c-ae500ba74a1d HTTP/1.1
2Host: api.didww.com
3Content-Type: application/vnd.api+json
4Accept: application/vnd.api+json
5Api-Key: [API token]

curl

1curl -i -X GET https://api.didww.com/v3/permanent_supporting_documents/d1a1a686-969a-4c02-954c-ae500ba74a1d -H "Accept: application/vnd.api+json" -H "Api-Key: [API token]" -H "Content-Type: application/vnd.api+json"

response

 1HTTP/1.1 200 OK
 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-04-16"
29    }
30}

Other Responses#

Code

Success

Description

404

No

Not Found

401

No

Unauthorized