Get Permanent Supporting Documents

Returns a list of permanent supporting documents on your account.

Request

HTTP Method: GET

URI Path: /v3/permanent_supporting_documents

Note

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

URI Query Parameters

Name	Type	Is Required?	Description
include	string	No	Inclusion
filter[<filter_name>]	string	No	Filtering
fields[permanent_supporting_documents]	string	No	Sparse fieldsets
sort	string	No	Sorting

Includes

Value	Description
template	Supporting Document Template Object
identity	Identity Object

Filters

Filter Name	Type	Allow Blank	Allow Array	Filters by:
external_reference_id	string	No	No	The external_reference_id field.

Sorting

Value	Sorts by:
created_at	The created_at field.
external_reference_id	The external_reference_id field.

Examples

Simple RequestFilter external_reference_id

http

GET /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]

curl

curl -i -X GET https://api.didww.com/v3/permanent_supporting_documents -H "Accept: application/vnd.api+json" -H "Api-Key: [API token]" -H "Content-Type: application/vnd.api+json"

response

HTTP/1.1 200 OK
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",
                "external_reference_id": null
            },
            "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": {
        "total_records": 1,
        "api_version": "2026-04-16"
    },
    "links": {
        "first": "https://api.didww.com/v3/permanent_supporting_documents?page%5Bnumber%5D=1&page%5Bsize%5D=50",
        "last": "https://api.didww.com/v3/permanent_supporting_documents?page%5Bnumber%5D=1&page%5Bsize%5D=50"
    }
}

Other Responses

Code	Success	Description
401	No	Unauthorized