# Supporting Document Templates

Use the Supporting Document Templates resource to retrieve forms that may be required for
DID registration.

A Supporting Document Template provides the form name, a download URL, and a `permanent`
attribute that determines how the completed document is used. Address Requirements can
reference separate templates for personal and business Identities and for permanent and
one-time documents.

Supporting Document Templates are read-only. Start with the applicable Address Requirement
to determine whether a template is required. Download and complete that specific form, then
encrypt and upload the completed document before linking it to the registration workflow.

Note

For the complete registration workflow, see [Regulation Resources](../index.html). For
an end-to-end purchasing and verification example, see [Buy a DID Number That
Requires Verification](../../../examples/buy-dids-with-verification.html).

## Permanent and one-time templates

An Address Requirement can reference the following template relationships:

| Relationship | Use |
| --- | --- |
| `personal_permanent_document` | Permanent form required for a personal Identity. |
| `business_permanent_document` | Permanent form required for a business Identity. |
| `personal_onetime_document` | One-time form required for a personal Identity. |
| `business_onetime_document` | One-time form required for a business Identity. |

Use the template's `permanent` value to continue the correct workflow:

- When `permanent` is `true`, create a Permanent Supporting Document that links the
  completed Encrypted File, the template, and the Identity. The document can be reused with
  that Identity where the same permanent document is required.
- When `permanent` is `false`, pass the completed Encrypted File in the `onetime_files`
  relationship when creating the Address Verification. Do not create a Permanent Supporting
  Document for a one-time form.

Important

Upload completed forms through [Create Encrypted File](../encrypted-files/create-encrypted-files.html). The endpoint
accepts one encrypted
`.pdf`, `.jpg`, or `.png` file per request. The file must not exceed 20 MB and
expires 24 hours after upload, so use its ID before it expires.

## Endpoints

| Action | Method | Endpoint |
| --- | --- | --- |
| Retrieve all Supporting Document Templates | `GET` | `/v3/supporting_document_templates` |
| Retrieve Supporting Document Template | `GET` | `/v3/supporting_document_templates/{id}` |

## Retrieve all Supporting Document Templates

Retrieves all Supporting Document Templates available in the DIDWW compliance catalog.

Use this endpoint to find templates by exact name, partial name, or permanent status. The
`url` attribute in each result provides the form to download.

See [Retrieve All Supporting Document Templates](get-supporting-document-templates.html).

```
GET /v3/supporting_document_templates
```

## Retrieve Supporting Document Template

Retrieves a specific Supporting Document Template by its unique ID.

Use this endpoint when an Address Requirement identifies the template and you need its
name, download URL, or permanent status before preparing the document.

See [Retrieve Supporting Document Template](get-supporting-document-template.html).

```
GET /v3/supporting_document_templates/{id}
```

## Data reference

See [Supporting Document Template Object](supporting-document-templates-object.html) for
all attributes returned by the resource.

## Common Supporting Document Template use cases

| Use case | Description |
| --- | --- |
| Retrieve a required form | Follow the template relationship from an Address Requirement and use `url` to download the required form. |
| Search templates by name | Filter by an exact name or use `name_contains` to find templates containing a search term. |
| Separate permanent and one-time forms | Filter by `permanent` or inspect the attribute to determine how the completed form must be linked. |
| Prepare a reusable document | Complete a permanent form, upload it as an Encrypted File, and create a Permanent Supporting Document for the Identity. |
| Prepare a one-time document | Complete a one-time form, upload it as an Encrypted File, and link the file when creating the Address Verification. |
| Avoid unnecessary documents | Create a supporting document only when the applicable Address Requirement references its template. |

## Related resources

- [Address Requirements](../requirements/index.html) - Determine whether a personal or
  business permanent or one-time template is required.
- [Encrypted Files](../encrypted-files/index.html) - Encrypt and upload completed forms.
- [Permanent Supporting Documents](../permanent-documents/index.html) - Link a completed
  permanent form to an Identity.
- [Address Verifications](../address-verifications/index.html) - Attach completed one-time
  forms through the `onetime_files` relationship.
- [Identities](../identities/index.html) - Manage the personal or business Identity linked
  to a Permanent Supporting Document.

On this page