List a brand's documents

GET/api/v1/sms/brands/{id}/documents

GET /sms/brands/{id}/documents

curl -X GET 'https://www.unitpost.com/api/v1/sms/brands/sms_123/documents' \
  -H 'Authorization: Bearer YOUR_API_KEY' \
  -H 'User-Agent: my-app/1.0'

Response · 200

{
  "object": "list",
  "has_more": false,
  "data": [
    {
      "object": "sms_brand_document",
      "id": "id_123",
      "brand_id": "brand_123",
      "kind": "registration_certificate",
      "carrier": "string",
      "country": "string",
      "label": "string",
      "input": "file",
      "filename": "string",
      "content_type": "string",
      "size_bytes": 1,
      "text_value": "string",
      "created_at": "2026-01-01T00:00:00.000Z"
    }
  ]
}

The brand's current company documents (ADR-0115): one per slot (kind + carrier), plus a country's own version of a shared one (country). Sender ID countries and document-gated registrations read them; a request that lacks one is refused naming it. Requires the sms:read capability.

Parameters1 field

Field	Type	Description
`id`required	string · path	—

Response · 200 fields13 fields

Field	Type	Description
`object`required	string	—
`id`required	string	—
`brand_id`required	string	—
`kind`required	enumregistration_certificate \| letter_of_authorization \| proof_of_sender_id_connection \| signatory_id \| emirates_id \| signatory_passport \| establishment_card \| power_of_attorney \| business_license \| tax_document \| regulatory_license \| carrier_registration_form \| opt_in_screenshot \| business_number	—
`carrier`required	string \| null	The slot's variant: which carrier or form a letter is addressed to (e.g. `ooredoo`), or null.
`country`required	string \| null	Set when this is one country's own version of a shared document (ADR-0115): it goes to that country only, in place of the shared file. Null for the shared file.
`label`required	string	What the document is, in words: "Letter of authorization — Ooredoo (Qatar)".
`input`required	enumfile \| text	—
`filename`required	string \| null	—
`content_type`required	string \| null	—
`size_bytes`required	integer \| null	—
`text_value`required	string \| null	`business_number` only.
`created_at`required	string	—

200401403404422

List a brand's documents

List a brand's documents

Search docs and guides