Get Supporting Document Templates#

Lists all supporting document templates.

Request#

HTTP Method: GET

URI Path: /v3/supporting_document_templates

Note

For all returned data attributes, see Supporting Document Templates Object.

URI Query Parameters#

Name

Type

Is Required?

Description

filter[<filter_name>]

string, boolean

No

Filtering

fields[supporting_document_templates]

string

No

Sparse fieldsets

sort

string

No

Sorting

page[number]

integer

No

Page number.

page[size]

integer

No

Page size. Pagination defaults to 50 records per page. The maximum is 100.

Filters#

Filter Name

Type

Allow Blank

Allow Array

Filters by:

id

string

No

Yes

The id field.

permanent

boolean

No

No

The permanent field.

name

string

No

Yes

The name field exact match.

name_contains

string

No

No

The name field contains.

Sorting#

Value

Sorts by:

name

The name field.

permanent

The permanent field.

Examples#

http

1GET /v3/supporting_document_templates HTTP/1.1
2Host: api.didww.com
3Content-Type: application/vnd.api+json
4Accept: application/vnd.api+json
5Authorization: Bearer [access token]

curl

1curl -i -X GET https://api.didww.com/v3/supporting_document_templates -H "Accept: application/vnd.api+json" -H "Content-Type: application/vnd.api+json" -H "Authorization: Bearer [access token]"

response

 1HTTP/1.1 200 OK
 2Content-Type: application/vnd.api+json
 3
 4{
 5    "data": [
 6        {
 7            "id": "206ccec2-1166-461f-9f58-3a56823db548",
 8            "type": "supporting_document_templates",
 9            "attributes": {
10                "name": "Generic LOI",
11                "permanent": false,
12                "url": "https://api.didww.com/storage/public/w7f2irbo819la7vd7up7u67pkmkn"
13            }
14        },
15        {
16            "id": "fd38c86d-b69b-4ca8-b73c-286a3b93d107",
17            "type": "supporting_document_templates",
18            "attributes": {
19                "name": "Belgium Registration Form",
20                "permanent": true,
21                "url": "https://api.didww.com/storage/public/e8lziulj68xetfa5ed6na3g7q7ra"
22            }
23        },
24        {
25            "id": "4199435f-646e-4e9d-a143-8f3b972b10c5",
26            "type": "supporting_document_templates",
27            "attributes": {
28                "name": "Germany Special Registration Form",
29                "permanent": true,
30                "url": "https://api.didww.com/storage/public/4rghqnqtba0fa7mbdgig086xej1e"
31            }
32        },
33        {
34            "id": "94be4d74-c968-4d81-91c5-2d11b4e45328",
35            "type": "supporting_document_templates",
36            "attributes": {
37                "name": "LOI Example",
38                "permanent": false,
39                "url": "https://api.didww.com/storage/public/xptvgb8derrz0ru95wr9oi68g9tg"
40            }
41        },
42        {
43            "id": "eb810289-8620-44e1-982d-13e6cee70404",
44            "type": "supporting_document_templates",
45            "attributes": {
46                "name": "TestPermanDoc",
47                "permanent": true,
48                "url": "https://api.didww.com/storage/public/owwqi77007ks4qx198b7su3eukg6"
49            }
50        },
51        {
52            "id": "f65149c1-b551-4444-97d7-22939445c42a",
53            "type": "supporting_document_templates",
54            "attributes": {
55                "name": "TestDoc4",
56                "permanent": true,
57                "url": "https://api.didww.com/storage/public/txm3ftmuhyhypm6553b2874iuljg"
58            }
59        },
60        {
61            "id": "8aacfda9-f78a-4d17-8d05-82e344bf822d",
62            "type": "supporting_document_templates",
63            "attributes": {
64                "name": "test",
65                "permanent": false,
66                "url": "https://api.didww.com/storage/public/of8dctya2w8fqf3hxu71a3hcmsa4"
67            }
68        },
69        {
70            "id": "83f83c27-af8d-43f4-a9ca-a84c363e3e25",
71            "type": "supporting_document_templates",
72            "attributes": {
73                "name": "Brazilian DIDWW LOA",
74                "permanent": false,
75                "url": "https://api.didww.com/storage/public/gvbw9l9jcegb5re30afhpu4eisvu"
76            }
77        },
78        {
79            "id": "6da59922-6c98-4cfa-bd0e-ec15f71eb1ff",
80            "type": "supporting_document_templates",
81            "attributes": {
82                "name": "Test34",
83                "permanent": false,
84                "url": "https://api.didww.com/storage/public/o9rz29nhi4eoip5obmtuv7w23cvf"
85            }
86        }
87    ],
88    "meta": {
89        "total_records": 30,
90        "api_version": "2026-11-19"
91    },
92    "links": {
93        "first": "https://api.didww.com/v3/supporting_document_templates?page%5Bnumber%5D=1&page%5Bsize%5D=50",
94        "last": "https://api.didww.com/v3/supporting_document_templates?page%5Bnumber%5D=1&page%5Bsize%5D=50"
95    }
96}

Other Responses#

Code

Success

Description

400

No

Bad Request. Malformed request: unknown filter, bad pagination or bad sort field.

401

No

Unauthorized

429

No

The request budget of the account for the current window is spent (too_many_requests). Retry-After gives the number of seconds to wait.