# Amplify API

- [Amplify API](https://developer.amplify.xyz/index.md): Build communications workflows with the Amplify platform.
- [Quickstart](https://developer.amplify.xyz/quickstart.md): Authenticate and make your first Amplify API request.
- [Authentication](https://developer.amplify.xyz/guides/authentication.md): Learn how to exchange an Amplify API key for an access token and authenticate customer API requests.
- [API conventions](https://developer.amplify.xyz/guides/api-conventions.md): Understand Amplify API naming, versioning, and resource behavior.
- [Data formats](https://developer.amplify.xyz/guides/data-formats.md): Common formats used for phone numbers, timestamps, files, URLs, and API values.
- [OCR and NLP response formats](https://developer.amplify.xyz/guides/ocr-nlp-response-formats.md): Understand the different extraction result shapes returned for OCR and NLP.
- [Requests and responses](https://developer.amplify.xyz/guides/requests-and-responses.md): Learn the shared formats used by Amplify API operations.
- [Pagination](https://developer.amplify.xyz/guides/pagination.md): Navigate large collections with opaque cursors.
- [Errors](https://developer.amplify.xyz/guides/errors.md): Handle Amplify API errors consistently.
- [Rate limits](https://developer.amplify.xyz/guides/rate-limits.md): Monitor limits and recover from rate-limited requests.
- [Webhooks overview](https://developer.amplify.xyz/webhooks/overview.md): Receive asynchronous Amplify resource updates.
- [Create a webhook](https://developer.amplify.xyz/webhooks/create-webhook.md): Configure and test a webhook from the Amplify dashboard.
- [Webhook events](https://developer.amplify.xyz/webhooks/events.md): Understand event names and webhook payloads.
- [Verifying webhooks](https://developer.amplify.xyz/webhooks/verifying-webhooks.md): Protect webhook endpoints while signature verification is unavailable.
- [Webhook retry behavior](https://developer.amplify.xyz/webhooks/retry-behavior.md): Design webhook consumers for reliable event processing.
- [Generate an access token](https://developer.amplify.xyz/api-reference/authentication/generate-access-token.md): Exchange an Amplify API key for a Bearer access token.
- [Send a fax](https://developer.amplify.xyz/api-reference/fax/post-fax-send.md): Send a fax with PDF documents supplied as JSON.
- [Forward a fax](https://developer.amplify.xyz/api-reference/fax/post-fax-forward.md): Forward the documents from an existing fax job to another fax number.
- [Resend a fax](https://developer.amplify.xyz/api-reference/customer-v1/fax-send-and-manage-faxes/post-faxes-resend.mdx.md): Resubmit a cancelled or failed fax.
- [List sent faxes](https://developer.amplify.xyz/api-reference/customer-v1/fax-send-and-manage-faxes/post-faxes-lists.mdx.md): Retrieve sent fax jobs and their current transmission results.
- [Get fax status](https://developer.amplify.xyz/api-reference/customer-v1/fax-send-and-manage-faxes/post-faxes-status.mdx.md): Retrieve the current transmission status and delivery details for a fax job.
- [List scheduled faxes](https://developer.amplify.xyz/api-reference/customer-v1/fax-send-and-manage-faxes/get-faxes-schedule.mdx.md): Retrieve faxes scheduled for future transmission.
- [Cancel a scheduled fax](https://developer.amplify.xyz/api-reference/customer-v1/fax-send-and-manage-faxes/post-faxes-cancel-schedule.mdx.md): Cancel a fax before its scheduled transmission time.
- [Cancel a fax](https://developer.amplify.xyz/api-reference/customer-v1/fax-send-and-manage-faxes/post-faxes-cancel.mdx.md): Cancel a fax that has not completed transmission.
- [List received faxes](https://developer.amplify.xyz/api-reference/customer-v1/fax-receive-faxes/post-faxes-received.mdx.md): Retrieve received faxes for a specified account number and order.
- [List all received faxes](https://developer.amplify.xyz/api-reference/customer-v1/fax-receive-faxes/get-faxes-all-received.mdx.md): Retrieve every received fax available to the authenticated account.
- [Assign a fax to a user](https://developer.amplify.xyz/api-reference/customer-v1/fax-receive-faxes/post-faxes-assign.mdx.md): Assign a fax to one or more workspace users.
- [Unassign a fax from a user](https://developer.amplify.xyz/api-reference/customer-v1/fax-receive-faxes/post-faxes-unassign.mdx.md): Remove a fax assignment from one or more workspace users.
- [Download a fax](https://developer.amplify.xyz/api-reference/customer-v1/fax-send-and-manage-faxes/post-faxes-download.mdx.md): Download a fax document as a Base64-encoded PDF.
- [Get a fax transmission receipt](https://developer.amplify.xyz/api-reference/customer-v1/fax-send-and-manage-faxes/post-faxes-transmission-receipt.mdx.md): Download a fax transmission receipt as a Base64-encoded PDF.
- [List pending fax approvals](https://developer.amplify.xyz/api-reference/customer-v1/fax-send-and-manage-faxes/post-faxes-pending-approval.mdx.md): Retrieve faxes waiting for approval.
- [Approve or reject a fax](https://developer.amplify.xyz/api-reference/customer-v1/fax-send-and-manage-faxes/post-faxes-approval.mdx.md): Approve or reject one or more pending fax requests.
- [Mark a fax as done](https://developer.amplify.xyz/api-reference/customer-v1/fax-send-and-manage-faxes/post-faxes-mark-as-done.mdx.md): Mark an inbound or outbound fax as done.
- [Mark a fax as not done](https://developer.amplify.xyz/api-reference/customer-v1/fax-send-and-manage-faxes/post-faxes-mark-as-not-done.mdx.md): Mark an inbound or outbound fax as not done.
- [Delete a fax](https://developer.amplify.xyz/api-reference/customer-v1/fax-send-and-manage-faxes/delete-faxes-delete.mdx.md): Permanently delete a fax.
- [Request OCR and NLP processing](https://developer.amplify.xyz/api-reference/customer-v1/fax-ocr-and-nlp/post-ai-process.mdx.md): Request OCR or NLP processing for a fax.
- [Extract OCR and NLP data](https://developer.amplify.xyz/api-reference/customer-v1/fax-ocr-and-nlp/post-ai-extract.mdx.md): Retrieve OCR or NLP data generated for a fax.
- [List labels](https://developer.amplify.xyz/api-reference/customer-v1/fax-labels/get-labels-list.mdx.md): List labels available in the workspace.
- [Assign a label to a fax](https://developer.amplify.xyz/api-reference/customer-v1/fax-labels/post-labels-assign.mdx.md): Assign labels to a fax.
- [Remove a label from a fax](https://developer.amplify.xyz/api-reference/customer-v1/fax-labels/post-labels-remove.mdx.md): Remove labels from a fax.
- [List fax custom fields](https://developer.amplify.xyz/api-reference/customer-v1/fax-custom-fields/post-custom-field-list.mdx.md): List custom fields associated with a fax.
- [Create or update a fax custom field](https://developer.amplify.xyz/api-reference/customer-v1/fax-custom-fields/post-custom-field-save.mdx.md): Create or update custom-field values for a fax.
- [Remove a fax custom field](https://developer.amplify.xyz/api-reference/customer-v1/fax-custom-fields/post-custom-field-remove.mdx.md): Clear custom-field values from a fax.
- [List available countries](https://developer.amplify.xyz/api-reference/customer-v1/numbers/get-numbers-country-list.mdx.md): List countries where Amplify phone numbers are available.
- [List available areas](https://developer.amplify.xyz/api-reference/customer-v1/numbers/post-numbers-area-list.mdx.md): List geographic areas and area codes available within a country.
- [List available numbers](https://developer.amplify.xyz/api-reference/customer-v1/numbers/post-numbers-available-list.mdx.md): List phone numbers available in a country and area code.
- [Search available numbers](https://developer.amplify.xyz/api-reference/customer-v1/numbers/post-numbers-search.mdx.md): Check whether a specific E.164 phone number is available to purchase.
- [List filled requirements](https://developer.amplify.xyz/api-reference/customer-v1/numbers/post-numbers-filled-requirements.mdx.md): Retrieve regulatory requirements and saved values for a country.
- [Purchase a number](https://developer.amplify.xyz/api-reference/customer-v1/numbers/post-numbers-purchase.mdx.md): Purchase an available phone number for your Amplify account.
- [Purchase a number with requirements](https://developer.amplify.xyz/api-reference/customer-v1/numbers/post-numbers-purchase-with-requirements.mdx.md): Purchase a phone number and submit its regulatory requirements.
- [List owned numbers](https://developer.amplify.xyz/api-reference/customer-v1/numbers/get-numbers-list.mdx.md): List phone numbers associated with your Amplify account.
- [Delete a number](https://developer.amplify.xyz/api-reference/customer-v1/numbers/post-numbers-delete.mdx.md): Remove an owned phone number from Amplify and deprovision it from the carrier.
- [Create Address](https://developer.amplify.xyz/api-reference/customer-v1/numbers-verification/post-numbers-verification-create-address.mdx.md): Create an address record for a phone number's regulatory requirements.
- [Upload Document](https://developer.amplify.xyz/api-reference/customer-v1/numbers-verification/post-numbers-verification-upload-document.mdx.md): Upload supporting evidence for phone number verification.
- [Upload Did Requirements](https://developer.amplify.xyz/api-reference/customer-v1/numbers-verification/post-numbers-verification-upload-did-requirements.mdx.md): Submit regulatory information required for approval of a phone number.
- [Create a contact](https://developer.amplify.xyz/api-reference/customer-v1/contacts/post-contacts-create.mdx.md): Customer API v1 endpoint.
- [Upload patient doc](https://developer.amplify.xyz/api-reference/customer-v1/contacts/post-contacts-upload-patient-doc.mdx.md): Customer API v1 endpoint.
- [List contacts](https://developer.amplify.xyz/api-reference/customer-v1/contacts/post-contacts-list.mdx.md): Customer API v1 endpoint.
- [Details](https://developer.amplify.xyz/api-reference/customer-v1/contacts/post-contacts-details.mdx.md): Customer API v1 endpoint.
- [Update a contact](https://developer.amplify.xyz/api-reference/customer-v1/contacts/post-contacts-update.mdx.md): Customer API v1 endpoint.
- [Delete a contact](https://developer.amplify.xyz/api-reference/customer-v1/contacts/post-contacts-delete.mdx.md): Customer API v1 endpoint.
- [List contact groups](https://developer.amplify.xyz/api-reference/customer-v1/contacts-groups/get-contacts-group-list.mdx.md): Customer API v1 endpoint.
- [Create a contact group](https://developer.amplify.xyz/api-reference/customer-v1/contacts-groups/post-contacts-group-create.mdx.md): Customer API v1 endpoint.
- [Update a contact group](https://developer.amplify.xyz/api-reference/customer-v1/contacts-groups/post-contacts-group-update.mdx.md): Customer API v1 endpoint.
- [Delete a contact group](https://developer.amplify.xyz/api-reference/customer-v1/contacts-groups/post-contacts-group-delete.mdx.md): Customer API v1 endpoint.
- [List contact custom fields](https://developer.amplify.xyz/api-reference/customer-v1/contacts-custom-fields/get-contacts-custom-field-list.mdx.md): Customer API v1 endpoint.
- [Create a contact custom field](https://developer.amplify.xyz/api-reference/customer-v1/contacts-custom-fields/post-contacts-custom-field-create.mdx.md): Customer API v1 endpoint.
- [Update a contact custom field](https://developer.amplify.xyz/api-reference/customer-v1/contacts-custom-fields/post-contacts-custom-field-update.mdx.md): Customer API v1 endpoint.
- [Delete a contact custom field](https://developer.amplify.xyz/api-reference/customer-v1/contacts-custom-fields/post-contacts-custom-field-delete.mdx.md): Customer API v1 endpoint.
- [Create Variable](https://developer.amplify.xyz/api-reference/customer-v1/collect-documents-document-variables/post-esign-documents-documentid-variables.mdx.md): Customer API v1 endpoint.
- [List Variables](https://developer.amplify.xyz/api-reference/customer-v1/collect-documents-document-variables/get-esign-documents-documentid-variables.mdx.md): Customer API v1 endpoint.
- [Get Variable](https://developer.amplify.xyz/api-reference/customer-v1/collect-documents-document-variables/get-esign-documents-documentid-variables-variableid.mdx.md): Customer API v1 endpoint.
- [Update Variable](https://developer.amplify.xyz/api-reference/customer-v1/collect-documents-document-variables/patch-esign-documents-documentid-variables-variableid.mdx.md): Customer API v1 endpoint.
- [Delete Variable](https://developer.amplify.xyz/api-reference/customer-v1/collect-documents-document-variables/delete-esign-documents-documentid-variables-variableid.mdx.md): Customer API v1 endpoint.
- [Create Fields](https://developer.amplify.xyz/api-reference/customer-v1/collect-documents-document-fields/post-esign-documents-documentid-fields.mdx.md): Customer API v1 endpoint.
- [List Fields](https://developer.amplify.xyz/api-reference/customer-v1/collect-documents-document-fields/get-esign-documents-documentid-fields.mdx.md): Customer API v1 endpoint.
- [Get Field](https://developer.amplify.xyz/api-reference/customer-v1/collect-documents-document-fields/get-esign-documents-documentid-fields-fieldid.mdx.md): Customer API v1 endpoint.
- [Update Fields (Bulk)](https://developer.amplify.xyz/api-reference/customer-v1/collect-documents-document-fields/patch-esign-documents-documentid-fields.mdx.md): Customer API v1 endpoint.
- [Update Field (Single Route)](https://developer.amplify.xyz/api-reference/customer-v1/collect-documents-document-fields/patch-esign-documents-documentid-fields-fieldid.mdx.md): Customer API v1 endpoint.
- [Delete Field](https://developer.amplify.xyz/api-reference/customer-v1/collect-documents-document-fields/delete-esign-documents-documentid-fields-fieldid.mdx.md): Customer API v1 endpoint.
- [Delete Multiple Fields](https://developer.amplify.xyz/api-reference/customer-v1/collect-documents-document-fields/post-esign-documents-documentid-fields-delete.mdx.md): Customer API v1 endpoint.
- [Create document theme](https://developer.amplify.xyz/api-reference/customer-v1/collect-documents-document-theme/post-esign-documents-documentid-theme.mdx.md): Customer API v1 endpoint.
- [Get Theme](https://developer.amplify.xyz/api-reference/customer-v1/collect-documents-document-theme/get-esign-documents-documentid-theme.mdx.md): Customer API v1 endpoint.
- [Update document theme](https://developer.amplify.xyz/api-reference/customer-v1/collect-documents-document-theme/patch-esign-documents-documentid-theme.mdx.md): Customer API v1 endpoint.
- [Delete Theme](https://developer.amplify.xyz/api-reference/customer-v1/collect-documents-document-theme/delete-esign-documents-documentid-theme.mdx.md): Customer API v1 endpoint.
- [Create Field Rule](https://developer.amplify.xyz/api-reference/customer-v1/collect-documents-document-field-rules/post-esign-documents-documentid-field-rule.mdx.md): Customer API v1 endpoint.
- [List Field Rules](https://developer.amplify.xyz/api-reference/customer-v1/collect-documents-document-field-rules/get-esign-documents-documentid-field-rule.mdx.md): Customer API v1 endpoint.
- [Update Field Rule](https://developer.amplify.xyz/api-reference/customer-v1/collect-documents-document-field-rules/patch-esign-documents-documentid-field-rule-fieldruleid.mdx.md): Customer API v1 endpoint.
- [Delete Field Rule](https://developer.amplify.xyz/api-reference/customer-v1/collect-documents-document-field-rules/delete-esign-documents-documentid-field-rule-fieldruleid.mdx.md): Customer API v1 endpoint.
- [List Documents](https://developer.amplify.xyz/api-reference/customer-v1/collect-documents/get-esign-documents.mdx.md): Customer API v1 endpoint.
- [Create Document](https://developer.amplify.xyz/api-reference/customer-v1/collect-documents/post-esign-documents.mdx.md): Customer API v1 endpoint.
- [Get document status](https://developer.amplify.xyz/api-reference/customer-v1/collect-documents/get-esign-documents-documentid.mdx.md): Customer API v1 endpoint.
- [Update Document](https://developer.amplify.xyz/api-reference/customer-v1/collect-documents/patch-esign-documents-documentid.mdx.md): Customer API v1 endpoint.
- [Send Document](https://developer.amplify.xyz/api-reference/customer-v1/collect-documents/post-esign-documents-documentid-send.mdx.md): Customer API v1 endpoint.
- [Download Document](https://developer.amplify.xyz/api-reference/customer-v1/collect-documents/get-esign-documents-documentid-download.mdx.md): Customer API v1 endpoint.
- [Delete Document](https://developer.amplify.xyz/api-reference/customer-v1/collect-documents/delete-esign-documents-documentid.mdx.md): Customer API v1 endpoint.
- [Delete Document Page](https://developer.amplify.xyz/api-reference/customer-v1/collect-documents/delete-esign-documents-documentid-pages-pagenumber.mdx.md): Customer API v1 endpoint.
- [Create Template Variable](https://developer.amplify.xyz/api-reference/customer-v1/collect-templates-template-variables/post-esign-templates-templateid-variables.mdx.md): Customer API v1 endpoint.
- [List Template Variables](https://developer.amplify.xyz/api-reference/customer-v1/collect-templates-template-variables/get-esign-templates-templateid-variables.mdx.md): Customer API v1 endpoint.
- [Get Template Variable](https://developer.amplify.xyz/api-reference/customer-v1/collect-templates-template-variables/get-esign-templates-templateid-variables-templatevariableid.mdx.md): Customer API v1 endpoint.
- [Update Template Variable](https://developer.amplify.xyz/api-reference/customer-v1/collect-templates-template-variables/patch-esign-templates-templateid-variables-templatevariableid.mdx.md): Customer API v1 endpoint.
- [Delete Template Variable](https://developer.amplify.xyz/api-reference/customer-v1/collect-templates-template-variables/delete-esign-templates-templateid-variables-templatevariableid.mdx.md): Customer API v1 endpoint.
- [Create template theme](https://developer.amplify.xyz/api-reference/customer-v1/collect-templates-template-theme/post-esign-templates-templateid-theme.mdx.md): Customer API v1 endpoint.
- [Get Template Theme](https://developer.amplify.xyz/api-reference/customer-v1/collect-templates-template-theme/get-esign-templates-templateid-theme.mdx.md): Customer API v1 endpoint.
- [Update template theme](https://developer.amplify.xyz/api-reference/customer-v1/collect-templates-template-theme/patch-esign-templates-templateid-theme.mdx.md): Customer API v1 endpoint.
- [Delete Template Theme](https://developer.amplify.xyz/api-reference/customer-v1/collect-templates-template-theme/delete-esign-templates-templateid-theme.mdx.md): Customer API v1 endpoint.
- [Create Template Fields](https://developer.amplify.xyz/api-reference/customer-v1/collect-templates-template-fields/post-esign-templates-templateid-fields.mdx.md): Customer API v1 endpoint.
- [List Template Fields](https://developer.amplify.xyz/api-reference/customer-v1/collect-templates-template-fields/get-esign-templates-templateid-fields.mdx.md): Customer API v1 endpoint.
- [Get Template Field](https://developer.amplify.xyz/api-reference/customer-v1/collect-templates-template-fields/get-esign-templates-templateid-fields-fieldtemplateid.mdx.md): Customer API v1 endpoint.
- [Update Template Fields (Bulk)](https://developer.amplify.xyz/api-reference/customer-v1/collect-templates-template-fields/patch-esign-templates-templateid-fields.mdx.md): Customer API v1 endpoint.
- [Update Template Field (Single Route)](https://developer.amplify.xyz/api-reference/customer-v1/collect-templates-template-fields/patch-esign-templates-templateid-fields-fieldtemplateid.mdx.md): Customer API v1 endpoint.
- [Delete Template Field](https://developer.amplify.xyz/api-reference/customer-v1/collect-templates-template-fields/delete-esign-templates-templateid-fields-fieldtemplateid.mdx.md): Customer API v1 endpoint.
- [Delete Multiple Template Fields](https://developer.amplify.xyz/api-reference/customer-v1/collect-templates-template-fields/post-esign-templates-templateid-fields-delete.mdx.md): Customer API v1 endpoint.
- [Create Template Field Rule](https://developer.amplify.xyz/api-reference/customer-v1/collect-templates-template-field-rules/post-esign-templates-templateid-field-rule.mdx.md): Customer API v1 endpoint.
- [List Template Field Rules](https://developer.amplify.xyz/api-reference/customer-v1/collect-templates-template-field-rules/get-esign-templates-templateid-field-rule.mdx.md): Customer API v1 endpoint.
- [Update Template Field Rule](https://developer.amplify.xyz/api-reference/customer-v1/collect-templates-template-field-rules/patch-esign-templates-templateid-field-rule-templatefieldruleid.mdx.md): Customer API v1 endpoint.
- [Delete Template Field Rule](https://developer.amplify.xyz/api-reference/customer-v1/collect-templates-template-field-rules/delete-esign-templates-templateid-field-rule-templatefieldruleid.mdx.md): Customer API v1 endpoint.
- [List Templates](https://developer.amplify.xyz/api-reference/customer-v1/collect-templates/get-esign-templates.mdx.md): Customer API v1 endpoint.
- [Create Template](https://developer.amplify.xyz/api-reference/customer-v1/collect-templates/post-esign-templates.mdx.md): Customer API v1 endpoint.
- [Get template details](https://developer.amplify.xyz/api-reference/customer-v1/collect-templates/get-esign-templates-templateid.mdx.md): Customer API v1 endpoint.
- [Update Template](https://developer.amplify.xyz/api-reference/customer-v1/collect-templates/patch-esign-templates-templateid.mdx.md): Customer API v1 endpoint.
- [Delete Template](https://developer.amplify.xyz/api-reference/customer-v1/collect-templates/delete-esign-templates-templateid.mdx.md): Customer API v1 endpoint.
- [Delete Template Page](https://developer.amplify.xyz/api-reference/customer-v1/collect-templates/delete-esign-templates-templateid-pages-pagenumber.mdx.md): Customer API v1 endpoint.

## OpenAPI Specs

- [customer-api](/openapi/customer-api.yaml)

## Optional

- [Amplify](https://amplify.xyz)