Retrieve a brand document

Retrieve a brand document

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

GET /sms/brands/{id}/documents/{documentId}
curl -X GET 'https://www.unitpost.com/api/v1/sms/brands/sms_123/documents/documentId_123' \
  -H 'Authorization: Bearer YOUR_API_KEY' \
  -H 'User-Agent: my-app/1.0'
Response · 200
{
  "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"
}

One current document of the brand. Requires the sms:read capability.

Parameters2 fields
FieldTypeDescription
idrequiredstring · path—
documentIdrequiredstring · path—
Response · 200 fields13 fields
FieldTypeDescription
objectrequiredstring—
idrequiredstring—
brand_idrequiredstring—
kindrequiredenumregistration_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—
carrierrequiredstring | nullThe slot's variant: which carrier or form a letter is addressed to (e.g. `ooredoo`), or null.
countryrequiredstring | nullSet 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.
labelrequiredstringWhat the document is, in words: "Letter of authorization — Ooredoo (Qatar)".
inputrequiredenumfile | text—
filenamerequiredstring | null—
content_typerequiredstring | null—
size_bytesrequiredinteger | null—
text_valuerequiredstring | null`business_number` only.
created_atrequiredstring—
200401403404422

Search docs and guides

Search the docs and product guides.