Sign in

v52

OpenAPI 3.1.0raw.githubusercontent.com2026-07-311,1941,9384.1 MB
Display Identity Records

Create a Display Identity Record (DIR)

Create a new DIR under the given enterprise. The DIR starts in draft status; it must be submitted (POST .../submit) and approved by Telnyx before any phone number can be attached.

Field rules

  • display_name: 1–35 characters, no emoji or whitespace-only strings; this is the name shown to recipients.
  • call_reasons: 1–10 strings, each ≤64 characters; describe why your business calls customers (e.g. 'Appointment reminders', 'Billing inquiries'). Validate the wording against POST /call_reasons/validate.
  • logo_url: HTTPS URL (max 128 chars) to a 256×256 BMP (max 1 MB). The image is downloaded and hashed at submission time.
  • documents: up to 20 entries; each document_id must be obtained by uploading the file via the Telnyx Documents API first. Within one DIR a document_id may only appear once.
  • certify_brand_is_accurate, certify_no_shaft_content, certify_ip_ownership MUST all be true.

Failure modes

  • 422 - validation error; errors[].source.pointer names the offending field.
  • 403 - Branded Calling not activated on this enterprise (see POST /enterprises/{id}/branded_calling).
  • 404 - enterprise does not exist or does not belong to your account.
post/enterprises/{enterprise_id}/dir

Path parameters

enterprise_idstring uuid required
Example:4a6192a4-573d-446d-b3ce-aff9117272a6

The enterprise id. Lowercase UUID.

Request body

authorizer_emailstring email required

Contact email of the authorizer. Telnyx may send verification or infringement-notice email here; use a monitored mailbox.

authorizer_namestring required

Name of the person at your enterprise who is authorizing this DIR registration. Must be a real individual (used for audit and trademark-claim contests).

call_reasonsstring[] required

1–10 reasons your business calls customers. Validate phrasing against POST /call_reasons/validate.

certify_brand_is_accuratetrue required

Must be true.

certify_ip_ownershiptrue required

Must be true. Confirms ownership of any logos/trademarks shown.

certify_no_shaft_contenttrue required

Must be true. Confirms this DIR is not used for SHAFT content (Sex, Hate, Alcohol, Firearms, Tobacco) where prohibited.

display_namestring required

Name shown to call recipients. No emoji; not whitespace-only.

logo_urlstring uri

Publicly accessible HTTPS URL (max 128 chars) to a 256x256 BMP logo (max 1 MB).

resellingboolean

Set to true if your organization places calls on behalf of other enterprises (BPO/reseller).

Example request

{
  "authorizer_email": "sam@acmeplumbing.example.com",
  "authorizer_name": "Sam Owner",
  "call_reasons": [
    "Appointment reminders",
    "Billing inquiries"
  ],
  "certify_brand_is_accurate": true,
  "certify_ip_ownership": true,
  "certify_no_shaft_content": true,
  "display_name": "Acme Plumbing",
  "documents": [
    {
      "description": "Certificate of incorporation.",
      "document_id": "2a7e8337-e803-4057-a4ae-26c40eb0bc6c",
      "document_type": "business_registration"
    }
  ],
  "logo_url": "https://acmeplumbing.example.com/logo-256.bmp"
}

Response

DIR created in draft status.

Example response

{
  "data": {
    "authorizer_email": "sam@acmeplumbing.example.com",
    "authorizer_name": "Sam Owner",
    "call_reasons": [
      {
        "created_at": "2026-04-26T18:06:51.940749Z",
        "reason": "Appointment reminders"
      }
    ],
    "certify_brand_is_accurate": true,
    "certify_ip_ownership": true,
    "certify_no_shaft_content": true,
    "created_at": "2026-04-26T18:06:51.940749Z",
    "display_name": "Acme Plumbing",
    "documents": [
      {
        "description": "Certificate of incorporation.",
        "document_id": "2a7e8337-e803-4057-a4ae-26c40eb0bc6c",
        "document_type": "business_registration"
      }
    ],
    "enterprise_id": "4a6192a4-573d-446d-b3ce-aff9117272a6",
    "expiring_at": "2027-04-26T18:07:29.537981Z",
    "id": "16635d38-75a6-4481-82e8-69af60e05011",
    "logo_url": "https://acmeplumbing.example.com/logo-256.bmp",
    "rejection_reasons": [
      {
        "code": "documentation_incomplete",
        "detail": "Provided documents do not establish business identity.",
        "message": "Please re-upload a clearer scan of the certificate.",
        "title": "Documentation incomplete"
      }
    ],
    "submitted_at": "2026-04-26T18:07:03.716411Z",
    "updated_at": "2026-04-26T18:09:24.785211Z",
    "verified_at": "2026-04-26T18:07:29.537926Z"
  }
}