Programadores

GET/v3/get_document/{uuid}

Consultar um perfil de cadastro

Consulte um perfil ativo pertencente à sua conta pelo UUID do documento local.

Nesta página
  1. Consultar um perfil armazenado
  2. Solicitação do perfil
  3. Resposta do perfil
  4. Campos do perfil retornados
  5. Perfil não encontrado e novas tentativas

Consultar um perfil armazenado

Obtenha o perfil de cadastro local ativo selecionado pelo UUID na sua conta. Esta consulta retorna os mesmos campos limitados do perfil que documents; ela não atualiza a verificação da operadora nem retorna os comprovantes anexados.

Solicitação do perfil

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

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

Defina DOCUMENT_UUID com o valor de response.uuid de create_document, ou de response[].id de documents. Não use identity_id, address_id, um identificador de comprovante ou um número de telefone aqui. Não é necessário um corpo de solicitação.

Resposta do perfil

{
  "status": {
    "code": 200,
    "msg": "Success"
  },
  "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"
  }
}

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, os seletores de país, identity_id, address_id, as referências a arquivos enviados, as listas de comprovantes e o status de verificação. Este endpoint não serve para consultar o status dos comprovantes nem a aprovação do cadastro. Trate os dados de identidade, contato e assinatura retornados como informações privadas.

Perfil não encontrado e novas tentativas

O código 404 da API com a mensagem Failed, Not found significa que nenhum perfil ativo correspondente foi encontrado para esta conta e este UUID. Verifique a conta, o identificador e se o perfil foi excluído. Esta consulta não revela o perfil de outra conta.

Uma consulta bem-sucedida não confirma a aceitação dos comprovantes nem a ativação do número. Se estiver tentando resolver uma solicitação de criação ou de anexação cujo resultado é incerto, examine o documento no portal antes de fazer outra solicitação que altere o estado.