Consultar um determinado CPF

Este artigo explica como consultar um determinado cliente usando o CPF através da REST API do Unico Check.

Esse método retorna os dados da pessoa através do CPF informado.

Como usar?

Faça uma requisição GET para o endpoint /subjects/{code}

Com o token de acesso válido, faça uma requisição para o endpoint (GET/subjects/{code}).

Parametros:

• HEADER PARAMETERS

Nome	Tipo	Mandatorio/Opcional	Descrição
APIKEY	String	Mandatório	API key
Authorization	String	Mandatório	Token de acesso

• PATH PARAMETERS

Nome	Tipo	Mandatorio/Opcional	Descrição
code	String	Mandatório	CPF da pessoa

Requisição com Sucesso

Se a requisição foi executada com sucesso, a resposta de retorno é um JSON contendo os seguintes parâmetros:

{
    "Code": "12345678910",
    "Gender": "M",
    "HasBiometry": true,
    "Name": "Bob"
}

Os parâmetros de retorno são:

Nome	Tipo	Descrição
Code	string	Indica o CPF da pessoa
Gender	string	Indica o gênero da pessoa (M ou F)
HasBiometry	boolean	Indica se o processo possui uma foto biometricamente válida ou não (se possui um rosto ou não).
Name	string	Nome da pessoa

Erro na Requisição

Caso ocorra algum erro, a resposta de retorno é um JSON contendo o código e descrição do erro:

{
    "Error": {
        "code": "40004",
        "description": "Descrição do erro"
    }
}

Para mais infomações sobre os erros retornados, consulte a lista disponível no artigo Response Errors.

Dúvidas?

Não encontrou algo ou ainda precisa de ajuda? Se já é um cliente ou parceiro, pode entrar em contato através da Central de Ajuda.