GetReusableDocuments

Esse artigo explica como verificar se existem documentos que podem ser reaproveitados através da REST API do Unico IDDocs.

Como usar?

Faça uma requisição GET para o endpoint /documents/v1?code={value}&type=BR_CPF

Com o token de acesso válido (e API KEY devidamente configurada para IDDocs), faça uma requisição para o endpoint (GET/documents/v1?code={value}&type=BR_CPF). O parâmetro {value} deve ser o CPF da pessoa física, sem pontos ou traços.

Parametros:

• HEADER PARAMETERS

Nome	Tipo	Mandatorio/Opcional	Descrição
APIKEY	String	Mandatório	API key
Authorization	String	Mandatório	Token de acesso
Content-Type	String	Mandatório	"application/json"

• QUERY STRING PARAMETERS

Nome	Tipo	Mandatorio/Opcional	Descrição
code	String	Mandatório	Valor do identificador da pessoa
type	String	Mandatório	Tipo do identificador da pessoa (Ex: BR_CPF)

Requisição com Sucesso

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

{
    "items": [{
        "documentType": "unico.moja.dictionary.br.rg.v2.Rg",
        "documentId": "2aaf6037-0153-415d-b9fe-cf7e8198408f"
    }]
}

Os parâmetros de retorno são:

Nome	Tipo	Descrição
items	Array	Lista de Documentos encontrados
items[*].documentType	String	Tipo do documento encontrado
items[*].documentId	String	ID do documento encontrado. Para reutilizar, deve-se usar esse id na chamada de Create Process

Dica: Testes em homologação

• Caso utilize o CPF (code) “12345678909” como um valor do parâmetro "BR_CPF" sempre retornamoremos um ID de documento válido. Para qualquer outro CPF não retornaremos nenhum ID.

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": "10700",
        "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.