Display Identity Records

List a DIR's authorized BPOs

Changed on

List the BPO (Business Process Outsourcer) accounts a Brand Owner has authorized on this DIR, together with the review state of each authorization.

Authorizations are supplied as the bpo_authorizations array when creating or updating a DIR, and each one is reviewed on its own. Only an approved authorization adds that BPO to this DIR's authorized callers in the branded calling registry; pending and rejected authorizations do not. Each entry includes the loa_document_id you submitted: because bpo_authorizations replaces the whole list on every DIR update, send each entry you want to keep back with its loa_document_id unchanged, and it keeps its review state. A rejected entry carries a rejection_reason. Returns an empty list when the DIR has authorized no BPOs.

get/dir/{dir_id}/bpo_authorizations

Request

  • Base URL: https://api.telnyx.com/v2
  • URL: https://api.telnyx.com/v2/dir/{dir_id}/bpo_authorizations
  • Auth: HTTP bearer

Path parameters

dir_idstring uuid required
Example:16635d38-75a6-4481-82e8-69af60e05011

The DIR id. Lowercase UUID.

Query parameters

page[number]integer
Example:1

1-based page number. Out-of-range values return an empty page with correct meta.

page[size]integer
Example:20

Items per page. Maximum 250; values above are clamped to 250.

Response

Paginated list of the DIR's BPO authorizations.

Example response

{
  "data": [
    {
      "record_type": "bpo_authorization",
      "bpo_enterprise_id": "4a6192a4-573d-446d-b3ce-aff9117272a6",
      "status": "pending",
      "loa_document_id": "2a7e8337-e803-4057-a4ae-26c40eb0bc6c",
      "rejection_reason": "Letter of Authorization is unsigned"
    }
  ],
  "meta": {
    "total_pages": 3,
    "total_results": 42,
    "page_number": 1,
    "page_size": 20
  }
}

Changes