Submit a DIR's references
Changed onSubmit the two business references and one financial reference for a DIR.
References (two business references and one financial reference) are needed only if the documents uploaded with the DIR don't already prove the business is legitimate and financially stable. Any one of these is enough proof: audited or certified financial statements (uploaded as other, with a description), a commercial credit report (uploaded as business_credit_report), or references. Telnyx reviewers decide during vetting whether your documents are enough.
References can't be changed while the DIR is verified. Update the DIR first, which returns it to draft.
The request body carries exactly two business references plus one financial reference. The first submission stores them and returns 201. Resubmitting returns 200: identical values are simply confirmed and nothing is written, while changed values replace those references.
A replaced reference's pending verification call is cancelled and its dial-in code stops working, and the replacement contact is emailed fresh scheduling details. References whose details did not change keep their existing call, code, and the notice already sent to them.
The response always echoes the stored references in the same shape as the GET.
Who qualifies: the two business references confirm the company's reputation and operations. Each should be a senior contact at an organization the business works with, such as a vendor, partner, or client: a C-suite executive (CEO, CFO, CTO, COO), an owner or founder as reflected in the company's corporate records, or a senior manager, director, or executive. The financial reference confirms the company pays its bills and should be a licensed certified public accountant (CPA) the company uses, a contact at a bank or financial institution that has a relationship with the company, or a reasonable alternative banking or financial reference.
Request
- Base URL: https://api.telnyx.com/v2
- URL: https://api.telnyx.com/v2/dir/{dir_id}/references
- Auth: HTTP bearer
Path parameters
The DIR id. Lowercase UUID.
Request body
Example request
{
"business_references": [
{
"full_name": "Dana Reyes",
"job_title": "VP of Operations",
"organization": "Acme Logistics",
"relationship_to_registrant": "Supplier",
"phone_e164": "+14155550123",
"email": "dana.reyes@example.com",
"timezone": "America/New_York"
}
],
"financial_reference": {
"full_name": "Dana Reyes",
"job_title": "VP of Operations",
"organization": "Acme Logistics",
"relationship_to_registrant": "Supplier",
"phone_e164": "+14155550123",
"email": "dana.reyes@example.com",
"timezone": "America/New_York"
}
}Response
Resubmit accepted. Identical values were confirmed unchanged, or changed values replaced those references.
Example response
{
"data": [
{
"record_type": "dir_reference",
"ref_type": "business",
"slot": 1,
"full_name": "Dana Reyes",
"job_title": "VP of Operations",
"organization": "Acme Logistics",
"relationship_to_registrant": "Supplier",
"phone_e164": "+14155550123",
"email": "dana.reyes@example.com",
"timezone": "America/New_York"
}
]
}Changes
- breaking
added to the
request propertyallOflist - breaking
the
request property type changed fromobjectto no type - warning
removed the request property
/ - warning
removed the request property
/ - warning
removed the request property
/ - warning
removed the request property
/ - warning
removed the request property
/ - warning
removed the request property
/ - warning
removed the request property
/
- breaking
- breaking
the
//response property's max was increased from1.00to2.00for the response status - info
added the non-success response with the status
- info
added the success response with the status
- breaking