Manual do Dev
InstitucionalBlogService DeskStatus Page

Envio de imagens para Onboarding

Confira os eventos relativos ao envio de imagens para Onboarding.

beta

Suggest Edits

Os eventos de envio de imagens caracterizam-se por mensagens que comunicam ao destinatário o recebimento e o processamento de imagens para Onboarding.

Como esses eventos chegam ao recebedor via webhook, é preciso realizar previamente a sua configuração.

Contexto e nome do evento

Nos eventos de envio de imagens para Onboarding , o campo context sempre informará “Document”, enquanto o campo name poderá variar de acordo com a transação, conforme a tabela a seguir:

Nome do evento (name)Descrição
DOCUMENT_WAS_RECEIVEDA imagem do documento foi recebida, porém ela pode ainda não ter sido completamente analisada.
DOCUMENT_WAS_PROCESSEDA imagem do documento foi recebida e analisada.

EntityId

O campo entityId é o identificador da entidade emissora do evento e seu valor depende do contexto de sua emissão.

No contexto de documento, o entityId é o token.

Exemplos de eventos

Imagem do documento recebida 

{ 
   "entityId":"Wx07Wf3sdqqFat6KKicHs_8_8THcVHfJ", 
   "companyKey":"company_key", 
   "idempotencyKey":"d3a2e330-b42b-46b7-ae8e-f0942b5271fd", 
   "context":"Document", 
   "name":"DOCUMENT_WAS_RECEIVED", 
   "timestamp":"2022-06-29T15:10:21.0585476+00:00", 
   "correlationId":"d3a2e330-b42b-46b7-ae8e-f0942b5271fd", 
   "metadata":{ 
      "customerDocument":"12345678900" 
   }, 
   "data":{ 
      "token":"sjfdhsjakfgKKGIFGLkjbkjasgdklh", 
      "documentType":"RG", 
      "documentSide":"FRONT", 
      "status": "ANALYZING" 
   } 
}

{ 
   "entityId":"VL2xeaa2TQzmqbaX32FaRvujBQfAqcb_", 
   "companyKey": "company_key ", 
   "idempotencyKey":"e5a2ae6a-e7fc-446d-983e-fb51338c6310", 
   "context":"Document", 
   "name":"DOCUMENT_WAS_RECEIVED", 
   "timestamp":"2022-06-29T15:10:15.6697797+00:00", 
   "correlationId":"e5a2ae6a-e7fc-446d-983e-fb51338c6310", 
   "metadata":{ 
      "customerDocument":"12345678900" 
   }, 
   "data":{ 
      "token":"VL2xeaa2TQzmqbaX32FaRvujBQfAqcb_", 
      "documentType":"RG", 
      "documentSide":"BACK", 
      "status":"ANALYZING" 
   } 
}

{ 
   "entityId":"YR5GMNH.D3HMQKa2SfPjUwwlhx.kypcx", 
   "companyKey":"company_key ", 
   "idempotencyKey":"5d3b2bb2-dcd1-4398-8c02-8456fb26d65d", 
   "context":"Document", 
   "name":"DOCUMENT_WAS_RECEIVED", 
   "timestamp":"2022-06-29T15:10:18.386868+00:00", 
   "correlationId":"5d3b2bb2-dcd1-4398-8c02-8456fb26d65d", 
   "metadata":{ 
      "customerDocument":"12345678900" 
   }, 
   "data":{ 
      "token":"YR5GMNH.D3HMQKa2SfPjUwwlhx.kypcx", 
      "documentType":"CNH", 
      "documentSide":"FRONT", 
      "status":"ANALYZING" 
   } 
}

{ 
   "entityId":"g.Ryjg0PyjLHwisjNCMKgweiABLY0u3w", 
   "companyKey":"company_key", 
   "idempotencyKey":"0f2c87a2-a65d-4fa8-a110-62f8dbc9398a", 
   "context":"Document", 
   "name":"DOCUMENT_WAS_RECEIVED", 
   "timestamp":"2022-06-29T15:10:17.8142959+00:00", 
   "correlationId":"0f2c87a2-a65d-4fa8-a110-62f8dbc9398a", 
   "metadata":{ 
      "customerDocument":"12345678900" 
   }, 
   "data":{ 
      "token":"g.Ryjg0PyjLHwisjNCMKgweiABLY0u3w", 
      "documentType":"CNH", 
      "documentSide":"BACK", 
      "status":"ANALYZING" 
   } 
}

{ 
   "entityId":"xw6qQ7hTO96qOpFV9MGGYh2iIZPhf76V", 
   "companyKey":"company_key", 
   "idempotencyKey":"67e07769-e18b-448c-926d-a4c477e22e0a", 
   "context":"Document", 
   "name":"DOCUMENT_WAS_RECEIVED", 
   "timestamp":"2022-06-29T15:10:17.0274218+00:00", 
   "correlationId":"67e07769-e18b-448c-926d-a4c477e22e0a", 
   "metadata":{ 
      "customerDocument":"12345678900" 
   }, 
   "data":{ 
      "token":"xw6qQ7hTO96qOpFV9MGGYh2iIZPhf76V", 
      "documentType":"SELFIE", 
      "status":"ANALYZING" 
   } 
}

Imagem do documento processada

{ 
   "entityId":"Wx07Wf3sdqqFat6KKicHs_8_8THcVHfJ", 
   "companyKey":"company_key", 
   "idempotencyKey":"e02272ae-897b-45bc-917c-749fb56006f4", 
   "context":"Document", 
   "name":"DOCUMENT_WAS_PROCESSED", 
   "timestamp":"2022-06-29T15:10:24.1631484Z", 
   "correlationId":"e02272ae-897b-45bc-917c-749fb56006f4", 
   "metadata":{ 
      "customerDocument":"12345678900" 
   }, 
   "data":{ 
      "token":"Wx07Wf3sdqqFat6KKicHs_8_8THcVHfJ", 
      "documentType":"RG", 
      "documentSide":"FRONT", 
      "status":"ANALYSIS_COMPLETED", 
      "analyzedAt":"2022-06-29T15:10:24.1631484Z", 
      "faceMatch":{ 
         "status":"HAS_FACE_MATCH", 
         "similarity":99.9763, 
         "confidence":99.97799 
      }, 
      "documentDetails":{ 
         "status":"DETECTED_DOCUMENT", 
         "federativeUnit":"PERNAMBUCO", 
         "side":"A", 
         "placeOfBirth":"ESTADO DE PERNAMBUCO" 
      } 
   } 
}

{ 
   "entityId":"VL2xeaa2TQzmqbaX32FaRvujBQfAqcb_", 
   "companyKey":"company_key", 
   "idempotencyKey":"c16695e2-3369-4694-b4f7-a657a839fc6c", 
   "context":"Document", 
   "name":"DOCUMENT_WAS_PROCESSED", 
   "timestamp":"2022-06-29T15:10:18.9419179Z", 
   "correlationId":"c16695e2-3369-4694-b4f7-a657a839fc6c", 
   "metadata":{ 
      "customerDocument":"12345678900" 
   }, 
   "data":{ 
      "token":"VL2xeaa2TQzmqbaX32FaRvujBQfAqcb_", 
      "documentType":"RG", 
      "documentSide":"BACK", 
      "status":"ANALYSIS_COMPLETED", 
      "analyzedAt":"2022-06-29T15:10:18.9419179Z", 
      "documentDetails":{ 
         "status":"DETECTED_DOCUMENT", 
         "idNumber":"123456789", 
         "registerName":"PETER BENJAMIM PARKER", 
         "issueDate":"22/09/2014", 
         "birthDate":"19/02/1998", 
         "motherName":"MARY PARKER", 
         "side":"B" 
      } 
   } 
}

{ 
   "entityId":"YR5GMNH.D3HMQKa2SfPjUwwlhx.kypcx", 
   "companyKey":"company_key", 
   "idempotencyKey":"3cfbaff6-0a14-4db7-b855-6bf4cd3b59fb", 
   "context":"Document", 
   "name":"DOCUMENT_WAS_PROCESSED", 
   "timestamp":"2022-06-29T15:10:20.9297677Z", 
   "correlationId":"3cfbaff6-0a14-4db7-b855-6bf4cd3b59fb", 
   "metadata":{ 
      "customerDocument":"12345678900" 
   }, 
   "data":{ 
      "token":"YR5GMNH.D3HMQKa2SfPjUwwlhx.kypcx", 
      "documentType":"CNH", 
      "documentSide":"FRONT", 
      "status":"ANALYSIS_COMPLETED", 
      "analyzedAt":"2022-06-29T15:10:20.9297677Z", 
      "faceMatch":{ 
         "status":"HAS_FACE_MATCH", 
         "similarity":99.794975, 
         "confidence":99.993004 
      }, 
      "documentDetails":{ 
         "status":"DETECTED_DOCUMENT", 
         "idNumber":"1234567890", 
         "cpfNumber":"12345678900", 
         "registerName":"PETER BENJAMIM PARKER", 
         "driveLicenseCategory":"B", 
         "driveLicenseNumber":"12345678900", 
         "federativeUnit":"RS", 
         "issuedBy":"SSP", 
         "issueDate":"12/04/2019", 
         "birthDate":"16/01/1991", 
         "fatherName":"RICHARD PARKER", 
         "motherName":"MARY PARKER", 
         "validDate":"18/01/2024", 
         "category":"B", 
         "side":"A" 
      } 
   } 
}

{ 
   "entityId":"g.Ryjg0PyjLHwisjNCMKgweiABLY0u3w", 
   "companyKey":"company_key", 
   "idempotencyKey":"5de5b5aa-9502-4d15-a167-90d625566ab2", 
   "context":"Document", 
   "name":"DOCUMENT_WAS_PROCESSED", 
   "timestamp":"2022-06-29T15:10:22.6694109Z", 
   "correlationId":"5de5b5aa-9502-4d15-a167-90d625566ab2", 
   "metadata":{ 
      "customerDocument":"12345678900" 
   }, 
   "data":{ 
      "token":"g.Ryjg0PyjLHwisjNCMKgweiABLY0u3w", 
      "documentType":"CNH", 
      "documentSide":"BACK", 
      "status":"ANALYSIS_COMPLETED", 
      "analyzedAt":"2022-06-29T15:10:22.6694109Z", 
      "documentDetails":{ 
         "status":"DETECTED_DOCUMENT", 
         "issuePlace":"SOUSA, PB", 
         "issueDate":"28/09/2020", 
         "side":"B" 
      } 
   } 
}

{ 
   "entityId":"xw6qQ7hTO96qOpFV9MGGYh2iIZPhf76V", 
   "companyKey":"company_key", 
   "idempotencyKey":"cbf1e957-6b77-4a64-9f9b-c3c452cb77c6", 
   "context":"Document", 
   "name":"DOCUMENT_WAS_PROCESSED", 
   "timestamp":"2022-06-29T15:10:18.0122463Z", 
   "correlationId":"cbf1e957-6b77-4a64-9f9b-c3c452cb77c6", 
   "metadata":{ 
      "customerDocument":"12345678900" 
   }, 
   "data":{ 
      "token":"xw6qQ7hTO96qOpFV9MGGYh2iIZPhf76V", 
      "documentType":"SELFIE", 
      "status":"ANALYSIS_COMPLETED", 
      "analyzedAt":"2022-06-29T15:10:18.0122463Z", 
      "faceDetails":{ 
         "status": "DETECTED_FACE", 
         "confidence":99.999275, 
         "ageRange":{ 
            "low":25, 
            "high":35 
         }, 
         "sunglasses":{ 
            "value":false, 
            "confidence":99.99592 
         }, 
         "eyesOpen":{ 
            "value":true, 
            "confidence":92.05033 
         } 
      }, 
      "liveness":{ 
         "status":"LIVENESS_FOUND", 
         "confidence":1.2453, 
         "threshold":1.226 
      } 
   } 
}

🚧

Importante

Para conhecer a estrutura básica dos eventos com os campos que chegarão à sua API, consulte nossa documentação específica de Eventos.

Objeto data nos eventos de envio de imagens para Onboarding

O objeto data traz detalhes específicos do contexto em que o evento ocorre. No caso de eventos de envio de imagens para Onboarding, esse objeto irá variar de acordo com o evento, conforme explicitado a seguir:

Evento DOCUMENT_WAS_RECEIVED (Imagem do documento recebida)

  • token: token retornado no envio do documento;
  • documentType: tipo de documento, o qual pode ser: “RG”, “CNH” ou “SELFIE”;
  • documentSide: lado do documento (FRONT ou BACK);

📘

Nota

O tipo de documento “SELFIE” não possui o campo documentSide.

  • status: situação da análise, a qual pode ser: “ANALYZING” e “PARTIALLY_ANALYZED”

🚧

Importante

Todos os documentos (RG frente e verso, CNH frente e verso e SELFIE) apresentam os campos acima.

Evento DOCUMENT_WAS_PROCESSED (Imagem do documento processada)

  • token: token retornado no envio do documento;
  • documentType: tipo de documento, o qual pode ser: “RG”, “CNH” ou “SELFIE”;
  • documentSide: lado do documento (FRONT ou BACK);

📘

Nota

O tipo de documento “SELFIE” não possui o campo documentSide.

  • status: resultado da análise, o qual pode ser: “ANALYSIS_COMPLETED”, “UNEXPECTED_ERROR” e “IMAGE_TOO_LARGE”;

Todos os documentos (RG frente e verso, CNH frente e verso e SELFIE) apresentam os campos acima. Além disso, cada documento também traz os seguintes campos específicos:

RG (frente)

  • analyzedAt: data e hora em que a análise foi realizada;
    • faceMatch: objeto que contém informações referentes à análise do rosto exibido no documento:
    • status: resultado da análise que identifica a correspondência entre a face do titular do documento (target) e a da selfie previamente analisada (source). Os possíveis status são: “HAS_FACE_MATCH”, “UNMATCHED_DOCUMENT” ou “MANY_FACES_DETECTED”;
    • similarity: percentual de correspondência da selfie com a face do titular do documento;
    • confidence: percentual de confiabilidade da análise realizada.
  • documentDetails: objeto que contém informações sobre o documento analisado:
    • status: resultado da análise do texto extraído do documento. Esta análise determina se o tipo de documento enviado é o mesmo informado pelo cliente. Os possíveis status são: DETECTED_DOCUMENT, NO_DOCUMENT_FOUND e NO_INFO_FOUND;
    • federativeUnit: estado em que o documento foi emitido;
    • side: lado do documento, sendo “A” para a frente e “B” para o verso;
    • placeOfBirth: local de nascimento do cliente.

RG (verso)

  • analyzedAt: data e hora em que a análise foi realizada;
    • documentDetails: objeto que contém informações sobre o documento analisado:
    • status: resultado da análise do texto extraído do documento. Esta análise determina se o tipo de documento enviado é o mesmo informado pelo cliente. Os possíveis status são: DETECTED_DOCUMENT, NO_DOCUMENT_FOUND e NO_INFO_FOUND;
    • idNumber: número do documento de identidade;
    • registerName: nome do cliente como consta no documento;
    • issueDate: data em que o documento foi emitido;
    • birthDate: data de nascimento do cliente;
    • motherName: nome da mãe do cliente como consta no documento;
    • side: lado do documento, sendo “A” para a frente e “B” para o verso.

CNH (frente)

  • analyzedAt: data e hora em que a análise foi realizada;
  • faceMatch: objeto que contém informações referentes à análise do rosto exibido no documento:
    • status: resultado da análise que identifica a correspondência entre a face do titular do documento (target) e a da selfie previamente analisada (source). Os possíveis status são: “HAS_FACE_MATCH”, “UNMATCHED_DOCUMENT” ou “MANY_FACES_DETECTED”;
    • similarity: percentual de correspondência da selfie com a face do titular do documento;
    • confidence: percentual de confiabilidade da análise realizada;
  • documentDetails: objeto que contém informações sobre o documento analisado:
    • status: resultado da análise do texto extraído do documento. Esta análise determina se o tipo de documento enviado é o mesmo informado pelo cliente. Os possíveis status são: DETECTED_DOCUMENT, NO_DOCUMENT_FOUND e NO_INFO_FOUND;
    • idNumber: número do documento de identidade;
    • cpfNumber: número do Cadastro de Pessoas Físicas (CPF);
    • registerName: nome do cliente como consta no documento;
    • driveLicenseCategory: categoria da carteira de motorista, podendo ser “ACC”, “A”, “B” ou “C”;
    • driveLicenseNumber: número da carteira de motorista;
    • federativeUnit: estado em que o documento foi emitido;
    • issuedBy: entidade que emitiu o documento;
    • issueDate: data de emissão do documento;
    • birthDate: data de nascimento do cliente;
    • fatherName: nome do pai do cliente como consta no documento;
    • motherName: nome da mãe do cliente como consta no documento;
    • validDate: data de expiração do documento;
    • side: lado do documento, sendo “A” para a frente e “B” para o verso.

CNH (verso)

  • analyzedAt: data e hora em que a análise foi realizada;
  • documentDetails: objeto que contém informações sobre o documento analisado:
    • status: resultado da análise do texto extraído do documento. Esta análise determina se o tipo de documento enviado é o mesmo informado pelo cliente. Os possíveis status são: DETECTED_DOCUMENT, NO_DOCUMENT_FOUND e NO_INFO_FOUND;
    • issuePlace: local em que o documento foi emitido;
    • issueDate: data de emissão do documento;
    • side: lado do documento, sendo “A” para a frente e “B” para o verso.

Selfie

  • analyzedAt: data e hora em que a análise foi realizada;
  • faceDetails: objeto que contém informações referentes à análise do rosto exibido no documento:
    • status: situação da análise das características do rosto da pessoa. Os possíveis status são: “DETECTED_FACE”, “MANY_FACES_DETECTED” e “COULD_NOT_DETECT_FACE”;
    • confidence: percentual de confiabilidade da análise realizada;
    • ageRange: objeto que contém informações sobre o intervalo de idade da pessoa de acordo com a imagem analisada:
      • low: mínima idade possível;
      • high: máxima idade possível.
    • sunglasses: objeto que contém informações sobre o uso de óculos de sol:
      • value: resultado da análise, o qual pode ser “true” ou “false”;
      • confidence: percentual de confiabilidade da análise realizada.
    • eyesOpen: objeto que contém informações da análise que identifica se o cliente está com os olhos abertos:
      • value: resultado da análise, o qual pode ser “true” ou “false”;
      • confidence: percentual de confiabilidade da análise realizada.
    • liveness: objeto que contém informações referentes à prova de vida:
      • status: resultado da análise da prova de vida, o qual pode ser: “LIVENESS_FOUND”, “NO_LIVENESS” ou “COULD_NOT_DETECT_FACE”;
      • confidence: percentual de confiabilidade da análise realizada;
      • threshold: limite de precisão, em porcentagem.

❗️

Atenção

Se as imagens não forem aprovadas, não será possível prosseguir com o registro do cliente e nem criar uma conta. Consulte as recomendações contidas na página Orientações para envio de fotos.

Updated 11 months ago