Documentos - Introdução

A API de Documentoscopia extrai informações de uma imagem que represente um documento como CNH, RG entre outros de forma imediata.

Requisição

POST /api/documents

Parâmetros de requisição:

Parâmetro que deve ser enviado via Query Params(URL):

Campo	Descrição
report_id	Código do produto a ser requisitado. O código de cada produto está descrito nas sessões a seguir, nos detalhamentos de cada relatório.

Parâmetros que devem ser enviados no Body da requisição no formato JSON:

Campo	Descrição
doc_image	String base 64 que represente a imagem.
type	Tipo do documento (somente para OCR).
side	Lado do documento: - A (frente do documento); - B (verso do documento). (Somente para OCR).

Exemplo de requisição:

curl --location --request POST 'https://core.conhecaseucliente.com.br/api/documents?report_id=doc-ocr' \
--header 'Content-Type: application/json' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9.eyJhdWQiOiIxMDAwMDAxIiwianRpIjoiNTgyYWNhNTRmYTdlYTE0NTdiMDViNmM1NDUzMzgxZDc5OWRiOGU4Mzk1YzY5ZTA4YTExNDg2NjY1OThkM2U4YTVkY2UxN2U5MGM2NDk0ZTgiLCJpYXQiOjE2OTkzODMyMjguODA0NTEsIm5iZiI6MTY5OTM4MzIyOC44MDQ1MTUsImV4cCI6MTY5OTM4NTAyOC43OTYyMTgsInN1YiI6IiIsInNjb3BlcyI6W119.VaFhMERsuxNZCtNxmDQuB6y3MLuUaKCuPA5VmyijKBT2m6So6Iku5713kzjaDiZaAa87jghnq0xJAcrALikotqR4SCX9rnoHt1SN1t_p4ZLGx53n9mfJbhEMoSxn4L54u9lT471oo6JOnu0aaeYGv798bS4yKcCZq_myrLzIw8fM167qw8CGOthcgHXRdm8ryE3wgLzyH7N8W7U_ydQTh0Vfn3IU7AhMxX6E7Z6wIz47F3rIcNOH-EURcLNimxlKOZgz-1KRLkrg2xDuCH52b-b9-AQrVPwyQSa0565FW5LPckR9YR_6n2V0Xjjx5Xv4bw9NbsRzHUApiwqXgv4R_CzyZFDcOmugUIcRutuufEBUmklKSaWM0aTlIC0NAf8h1MIRCd917Zbbds9KxZcZzzUKnOD9PMRs4xAD40k2NbvLqih9v_XNdrhUtFfD6XKs9nddQnygbwFCBP0bm6u1hNB0izjjdpSi3WsA-dOXEe8LNCwU4ZKqbHFowARe6CSxUA5goh58M7OE5mcjdIK8T8yg6xKibAwGMrxvIVu7amVTTu8rAlJKJeuyQhRXHTQ49KmCxZ-921wAJB2aSoaSQsPKcQwMv4u5o3vXe18n6KEVsaHc76OJxxJDRjRI4b3mLSovm5VLYVsY6QIewtvcQ30r4sPgfq3ebCFbFClphCU' \
--data '{
    "doc_image": "String Base_64",
    "type": "RG",
    "side": "B"
'}

Retornos

É retornado sempre uma estrutura principal, contendo o cabeçalho da consulta (id, created_at, status e message) e o elemento doc_info com o conteúdo de cada relatório individualizado. Você encontrará os detalhes de retorno de cada relatório nas sessões a seguir.

Parâmetros de resposta:

Campo	Descrição
id	Identificador único da transação (UUID).
created_at	Data hora da requisição.
status	Status da transação PROCESS - Em Processamento; SUCCESS- Sucesso; UNAVAILABLE - Indisponibilidade; EXCEPTION - Exceção.
message	Elemento JSON contendo informação de êxito ou exceção.
doc_info	Elemento JSON com as informações extraídas do documento.

Apenas as transações com status SUCCESS geram cobranças.

Exemplo de resposta:

{    
    "id": "1876d480-5d69-4d7f-8f03-b83ba02fc605", 
    "created_at": "2022-08-17T16:34:23.000000Z", 
    "status": "SUCCESS",
    "message": {
        "code": 0,
        "message": null
    },
    "doc_info": { 
        //CONTEUDO DA DOCUMENTOSCOPIA
    } 
}

Códigos e Descrições de Erros

Na resposta da chamada sempre existirá um campo message do tipo object com os campos code e message.

Código	Mensagem	PRODUTO/API
402	CPF Belongs to minor	TODOS
1	Found info	OCR
2	Requisition sended to Manual Fallback.	OCR
3	Image analysed in Manual Fallback.	OCR
4	Found info. The sides of the documents were sent inverted	OCR
5	The face picture and the document picture does not match	OCR
6	No info was found on the provided picture	OCR
8	Missing mandatory parameters for API Call	OCR
9	Found info in OCR, but some error occured	OCR
10	Document Birthday and Official Birthday does not match	OCR
11	Age is under eighteen	OCR
12	Age is above one hundred	OCR
13	Difference between firt qualification date and birthday date is under eighteen	OCR
14	Difference between firt qualification date and birthday date is above one hundred	OCR
15	First qualification date is greater than the valid date	OCR
16	Document expired	OCR
17	Document is about sixty days or less to expire	OCR
18	Document has more than five years to expire	OCR
19	Birthday date is greater than the expiration date	OCR
20	Expedition date is greater than the expiration date	OCR
21	Birthday date is greater than the expedition date	OCR
22	First qualification date is greater than the expedition date	OCR
23	First qualification date is greater than the birthday date	OCR
24	Document has more than three years to expire	OCR
25	Document has more than ten years to expire	OCR
60	Success	QUALITY
80	Validated	MANIPULATION
81	Error has occurred in the Image Analysis.	MANIPULATION