Programadores

GET/v3/documents

Listar perfis de registro

Encontre os perfis locais ativos da conta usando a projeção limitada de campos legados.

Nesta página
  1. Encontrar perfis de registro existentes
  2. Solicitação de listagem
  3. Lista de resposta
  4. Campos do perfil retornados
  5. Próximos passos

Encontrar perfis de registro existentes

Liste os perfis de registro locais ativos e não excluídos associados à sua conta da API. Use esta operação para localizar o UUID de um perfil antes de abri-lo com get_document, e não para determinar se os comprovantes ou o registro do número foram aprovados.

Solicitação de listagem

Autentique-se com sua conta habilitada da API MultiTEL e o endereço IP permitido para ela. Os exemplos usam credenciais HTTP Basic armazenadas em variáveis de ambiente. Verifique tanto a resposta HTTP quanto o campo JSON status.code; uma resposta HTTP 200, por si só, não comprova o sucesso. Todos os valores dos exemplos são fictícios.

curl --silent --show-error --user "$API_USER:$API_PASSWORD" \
  https://api.multitel.net/v3/documents

Este processador de solicitações não implementa corpo de solicitação, paginação nem parâmetros de filtro. Ele retorna os perfis armazenados da conta correspondente; não presuma uma ordem específica. Evite consultas frequentes à lista completa em contas grandes.

Lista de resposta

{
  "status": {
    "code": 200,
    "msg": ""
  },
  "response": [
    {
      "id": "11111111111111111111111111111111",
      "first_name": "Example",
      "last_name": "Person",
      "phone_number": "12025550123",
      "id_number": "",
      "birth_date": null,
      "company_name": "",
      "company_reg_number": "",
      "vat_id": "",
      "personal_tax_id": "",
      "description": "Example profile",
      "identity_type": "Personal",
      "postal_code": "00000",
      "city": "Example City",
      "address": "1 Example Street",
      "signature": "BASE64_PNG_SIGNATURE_DATA",
      "date_created": "2026-10-23 16:00:00"
    }
  ]
}

Quando não há perfis ativos correspondentes, o processador de solicitações retorna o código de API 200 e uma lista de resposta vazia. response[].id é o UUID do perfil local retornado como uuid durante a criação; não é um ID de identidade nem um ID de endereço.

Campos do perfil retornados

A projeção contém id, first_name, last_name, phone_number, id_number, birth_date, company_name, company_reg_number, vat_id, personal_tax_id, description, identity_type, postal_code, city, address, signature e date_created.

Os valores opcionais podem estar vazios ou ser null, conforme os dados armazenados. Esta projeção legada omite email, seletores de país, identity_id, address_id, referências a arquivos enviados, listas de comprovantes e o estado da verificação. Este não é um endpoint para consultar o estado dos comprovantes ou a aprovação do registro. Trate os dados de identidade, contato e assinatura retornados como privados.

Próximos passos

Salve os IDs das entidades da resposta original de create_document para vinculações posteriores. Se essa resposta foi perdida, esta lista não permite recuperá-los. Examine o perfil no portal ou entre em contato com o suporte em vez de criar automaticamente um perfil duplicado.