Este endpoint entrega a operação de match 1:1 biométrico facial baseado em registros aprovados. Recebe uma mensagem JSON contendo um CPF e uma captura facial, faz a comparação desta com a biometria de referência que foi previamente cadastrada e aprovada na base biométrica CERTFY para este CPF deste cliente.
\nprocessId (opcional): String representando o identificador único do processo.
\ncustomerId (obrigatório): String representando o identificador único do cliente.
\ncpf (obrigatório): String contendo o CPF do indivíduo.
\nface (obrigatório): String em base64 contendo a imagem da biometria facial que se deseja verificar.
\nCaso a operação seja bem-sucedida, será enviada uma resposta com os seguintes campos:
\nIsGenuine: Valor booleano informando se as informações biométricas do indivíduo são compativeis
\nScore: Número indicando o nível de similaridade entre as biometrias, podendo valer entre 0 e 100. Quanto maior o número, maior a compatibilidade.
\nEste endpoint entrega a operação de match 1:1 biométrico facial baseado em registros aprovados e o fluxo utilizado. Recebe uma mensagem JSON contendo um CPF e uma captura facial, faz a comparação desta com a biometria de referência que foi previamente cadastrada e aprovada na base biométrica CERTFY para este CPF deste cliente.
\nprocessId (opcional): String representando o identificador único do processo.
\ncustomerId (obrigatório): String representando o identificador único do cliente.
\ncpf (obrigatório): String contendo o CPF do indivíduo.
\nface (obrigatório): String em base64 contendo a imagem da biometria facial que se deseja verificar.
\ncertificationRequestId (obrigatório): String em base64 contendo o identificador request.
\nCaso a operação seja bem-sucedida, será enviada uma resposta com os seguintes campos:
\nIsGenuine: Valor booleano informando se as informações biométricas do indivíduo são compativeis
\nScore: Número indicando o nível de similaridade entre as biometrias, podendo valer entre 0 e 100. Quanto maior o número, maior a compatibilidade.
\ncertificationData: String contendo o fluxo utilizado.
\nEste endpoint entrega operações de match 1:1 biométrico, sendo possível consumir match de biometria facial ou de biometria da impressão digital. Recebe uma mensagem JSON contendo duas capturas biométricas a qual deseja realizar a comparação.
\ncustomerId: (Obrigatório): String representando o identificador único do cliente.
\ncpf: (Obrigatório) String contendo o CPF do indivíduo.
\nface: Objeto contendo a informação das faces a serem comparadas, contendo os seguintes campos:
\nfaceImage: String de base64 contendo a biometria facial submetida a ser comparada.
\nfaceImageToCompare: String de base64 contendo a biometria facial de referência a ser comparada.
\nfingers: Objeto contendo a informação das digitais a serem comparadas, contendo os seguintes campos:
\nformatFingerImage: String informando o formato da primeira biometria digital a ser comparada, podendo ser base64 ou WSQ.
\nfingerImage: String contendo a primeira biometria digital a ser comparada.
\nformatFingerImateToCompare: String informando o formato da segunda biometria digital a ser comparada, podendo ser base64 ou WSQ.
\nfingerImageToCompare: String contendo a segunda biometria digital a ser comparada.
\nCaso a operação seja bem sucedida, o sistema retornará uma mensagem JSON com os seguintes campos:
\ncustomerId: ID do cliente informado na requisição
\ncpf: CPF do cliente informado na requisição
\nmatchDetails: Detalhes relacionados à operação de match, dividido entre os seguintes campos:
\nface: Detalhes referentes ao match da biometria facial, sendo eles:
\nmatched: Valor booleano informando se ocorreu match entre as biometrias faciais informadas.
\nscore: Número indicando o nível de similaridade entre as duas biometrias.
\nfingers: Detalhes relacionados ao match da biometria digital, sendo eles:
\nmatched: Valor booleano informando se ocorreu match entre as biometrias digitais.
\nscore: Número indicando o nível de similaridade entre as duas biometrias, podendo valer entre 0 e 100. Quanto maior o número, maior a compatibilidade.
\nEste endpoint entrega a operação de match 1:1 biométrico facial. Recebe uma mensagem JSON contendo um CPF e uma captura facial, faz a comparação desta com a biometria de referência que foi previamente cadastrada na base biométrica CERTFY para este CPF deste cliente.
\ncustomerId (obrigatório): String representando o identificador único do cliente.
\ncpf (obrigatório): String contendo o CPF do indivíduo.
\nface (obrigatório): String em base64 contendo a imagem da biometria facial que se deseja verificar.
\nCaso a operação seja bem-sucedida, será enviada uma resposta com os seguintes campos:
\nIsGenuine: Valor booleano informando se as informações biométricas do indivíduo são compativeis
\nScore: Número indicando o nível de similaridade entre as biometrias, podendo valer entre 0 e 100. Quanto maior o número, maior a compatibilidade.
\nOperação de checagem de idade numa imagem. Recebe como entrada uma imagem em base64 contendo a face do indivíduo que se deseja realizar a verificação.
\nCaso a operação seja bem sucedida, o sistema retornará uma mensagem com o parâmetro \"success\", que consiste em um valor booleano que será verdadeiro caso o sistema conste que o indivíduo está dentro do alcance de idade passado na requisição. Vale notar que, além disso, uma imagem com qualidade suficiente deve ser passada para que o sistema possa realizar a verificação.
\n","urlObject":{"path":["v1","age-check"],"host":["{{base-url}}"],"query":[],"variable":[]}},"response":[{"id":"a5e3ee17-1c78-4455-9433-1b7beac4d806","name":"Verificação de limite de idade (Maior de idade)","originalRequest":{"method":"POST","header":[{"key":"Ocp-Apim-Subscription-Key","value":"{{api-key}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"image\": \"{{face-base64-maior-de-idade}}\"\r\n}","options":{"raw":{"language":"json"}}},"url":"{{base-url}}/v1/age-check"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Ocp-Apim-Subscription-Key","value":"{{api-key}}","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"true"},{"id":"8f109b03-8f0f-4cff-92ea-8ccd7f549833","name":"Verificação de limite de idade (Menor de idade)","originalRequest":{"method":"POST","header":[{"key":"Ocp-Apim-Subscription-Key","value":"{{api-key}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"image\": \"{{face-base64-menor-de-idade}}\"\r\n}","options":{"raw":{"language":"json"}}},"url":"{{base-url}}/v1/age-check"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Ocp-Apim-Subscription-Key","value":"{{api-key}}","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"false"},{"id":"09b665c1-c7d1-49fc-8ff0-07b0eaabbedd","name":"Verificação de limite de idade (Erro no formato da imagem)","originalRequest":{"method":"POST","header":[{"key":"Ocp-Apim-Subscription-Key","value":"{{api-key}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"image\": \"{{face-base32}}\"\r\n}","options":{"raw":{"language":"json"}}},"url":"{{base-url}}/v1/age-check"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"key":"Ocp-Apim-Subscription-Key","value":"{{api-key}}","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"Message\": \"Imagem não é um Base64 válido!\",\n \"Errors\": null,\n \"Success\": false\n}"}],"_postman_id":"46ce2d80-640c-426a-8035-df15099527a8"},{"name":"Comparação & Liveness 2D","id":"cf9dea90-fe52-4289-b41e-371dd043b38a","protocolProfileBehavior":{"disableBodyPruning":true,"disabledSystemHeaders":{"content-length":true,"host":true,"content-type":true,"user-agent":true,"accept":true,"accept-encoding":true,"connection":true}},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"{{base-url}}/v2/match-liveness","description":"Operação de match biométrico, que pode receber duas imagens de face e duas imagens de impressão digital para realizar uma comparação biométrica 1:1 para cada biometria passada. Além disso, realiza o teste de vivacidade para a face de imagem submetida. Caso deseje, é possível realizar a operação usando apenas biometria facial ou apenas biometria de impressão digital. A operação recebe como entrada os seguintes campos:
\ncustomerId (obrigatório): String representando o identificador único do cliente.
\ncpf (Obrigatório): String contendo o CPF do indivíduo.
\nface: Objeto contendo a informação das faces a serem comparadas, contendo os seguintes campos:
\nfaceImage: String de base64 contendo a biometria facial submetida a ser comparada.
\nfaceImageToCompare: String de base64 contendo a biometria facial de referência a ser comparada.
\nfingers: Objeto contendo a informação das digitais a serem comparadas, contendo os seguintes campos:
\nformatFingerImage: String informando o formato da primeira biometria digital a ser comparada, podendo ser base64 ou WSQ.
\nfingerImage: String contendo a primeira biometria digital a ser comparada.
\nformatFingerImateToCompare: String informando o formato da segunda biometria digital a ser comparada, podendo ser base64 ou WSQ.
\nfingerImageToCompare: String contendo a segunda biometria digital a ser comparada.
\nCaso a operação seja bem sucedida, o sistema retornará uma mensagem contendo os seguintes campos:
\ncustomerId: ID do cliente informado na requisição
\ncpf: CPF do cliente informado na requisição
\nmatchDetails: Detalhes relacionados à operação de match, dividido entre os seguintes campos:
\nface: Detalhes referentes ao match da biometria facial, sendo eles:
\nmatched: Valor booleano informando se ocorreu match entre as biometrias faciais informadas.
\nscore: Número indicando o nível de similaridade entre as duas biometrias.
\nfingers: Detalhes relacionados ao match da biometria digital, sendo eles:
\nmatched: Valor booleano informando se ocorreu match entre as biometrias digitais.
\nscore: Número indicando o nível de similaridade entre as duas biometrias, podendo valer entre 0 e 100. Quanto maior o número, maior a compatibilidade.
\nlivenessResponse: Campo responsável por sinalizar o resultado do teste de Liveness. Nele, haverá o campo \"result\", sinalizando se houve ou não fraude, bem como uma mensagem de erro. Os seus possíveis valores podem ser observados a seguir:
\nOperação responsável por realizar o teste de vivacidade numa captura de biometria facial. Recebe como entrada a captura em formato de string base64 e retorna a validação da foto bem como o grau de confiança da operação.
\ncostumerId: Identificador do cliente.
\nlivenessFields: Objeto contendo os campos pertinentes à operação de Liveness.
\nvalue: Valor booleano validando a veracidade da captura, na qual true significa que a imagem passou no teste, e false significa que foi identificado o ataque.
\nconfidence: Grau de confiança da operação, de 0 a 100.
\nOperação responsável pelo recorte de imagem seguindo os padrões ICAO. Ao receber uma imagem de face, realiza o teste de Liveness 2D, verifica se a imagem obedece aos padrões estabelecidos pelo ICAO, e então performa o recorte da imagem centralizando o rosto do indivíduo.
\ncustumerID: Identificador do cliente.
\nface: Imagem de face codificada em string base64.
\nLiveness: Campo referente ao teste de Liveness 2D da imagem, indicando com \"true\" caso a imagem tenha sido aprovada, e um valor de 0 a 100 indicando o nível de confiança do resultado.
\nicaoResults: Objeto contendo as informações sobre o teste de conformidade aos padrões ICAO, contendo os seguintes campos:
\nfaceImageConformed: Campo indicando se a imagem está em conformidade com os padrões ICAO;
\nisAllConformed: Campo indicando se todos os itens do teste estão em conformidade com os padrões ICAO;
\nrequirements: Lista indicando cada campo que foi testado juntamente com a indicação se está ou não em conformidade com os padrões ICAO.
\nfaceResult: Imagem codificada em string base64 contendo o resultado final do recorte da imagem enviada ao sistema.
\nOperação responsável por validar a identidade facial a partir do CPF e da imagem da face (selfie). Este serviço retorna um rank de confiança da identidade, baseado em critérios biométricos e documentais, para uso em processos de certificação.
\ncustomerId: Identificador único do cliente solicitante.
\ncpf: CPF da pessoa a ser validada. Aceita formatos com ou sem pontuação.
\nface: Imagem da selfie codificada em base64.
\nO serviço Inspect v2 realiza uma análise de imagem de documentos (frente e verso) e retorna um status final sobre a validação, além de informações adicionais sobre o processamento.
\nprocessId (opcional): UUID que representa a execução do processo. Se não informado, será gerado automaticamente pelo sistema.
\ncustomerId (obrigatório): Identificador do cliente.
\nimageBack (opcional): Imagem do verso do documento em base64.
\ncpf (obrigatório): CPF do cliente a ser analisado.
\nimageFront (obrigatório): Imagem da frente do documento em base64.
\nfinalStatus: Representa o resultado final da análise.
Possíveis valores:
\"0\" = Aprovado
\n\"1\" = Reprovado (ex: dados divergentes, não encontrado na base, etc)
\n\"2\" = Inconclusivo (casos que seriam encaminhados para análise manual)
\nstatus: Indica se a extração dos dados ocorreu com sucesso.
\ntrue = Extração realizada com sucesso
\nfalse = Ocorreu um erro na extração
\nmessage: Mensagem explicativa em caso de erro. Exemplo: \"valor não encontrado\"
\nOperação responsável por extrair informações de um documento de identificação a partir de um arquivo único consolidado, realizando a classificação automática do tipo de documento e a verificação de dados.
\nprocessId: UUID representando o identificador único do processo.
\ncustomerId: String representando o identificador único do cliente.
\nfileBase64: String contendo o arquivo do documento codificado em base64.
\nId: Identificador único da transação.
\nVersion: Versão do motor de processamento.
\nData: Array contendo os resultados da análise:
\nExtraction: Objeto com os dados brutos extraídos (SchemaName, Person e
OtherFields).
Enhanced: Objeto com os dados otimizados e normalizados pelo sistema.
\nTaxData: Informações retornadas da base de dados da Receita Federal.
\nMatches: Booleano indicando o resultado do confronto de nome, nome da mãe e data de nascimento.
\nClassification: Detalhes sobre o tipo de documento, país, lado da imagem e se é a mesma captura.
\nMetadata: Informações técnicas sobre os arquivos enviados (FilesInfo) e tempo total de processamento (TimeSpent).
\nOperação que realiza o match entre a face contida em um documento e uma selfie capturada, integrando o teste de vivacidade (Liveness 2D) no mesmo fluxo.
\nprocessId: UUID representando o identificador único do processo.
\ncustomerId: String representando o identificador único do cliente.
\ndocumentImage: String em formato base64 com a imagem do documento.
\nfaceImage: String em formato base64 com a imagem da selfie capturada.
\nLiveness2d: Objeto contendo o resultado do teste de vivacidade:
\nProcessId: Identificador do processo de liveness.
\nResult: Resultado da análise de vivacidade (ex: \"No Fraud\").
\nFace: Objeto referente ao match biométrico:
\nMatched: Valor booleano indicando se houve compatibilidade entre as faces.
\nScore: Nível de similaridade entre as biometrias.
\nmessage: Mensagem explicativa sobre o resultado da operação.
\nOperação responsável pelo retorno da análise de documentoscopia a partir da imagem de um documento.
\ncostumerId: identificador do cliente
\ndocumentImage: Imagem frontal do documento do indivíduo em formato string base64
\nimageOfDocumentBack: Imagem traseira do documento do indivíduo em formato string base64
\nscore: Nível de confiabilidade da validade do documento.
\nstatus: Resultado da análise de documentoscopia.
\nreason: Justificativa para o resultado da análise.
\nOperação responsável por extrair as informações contidas num documento e averiguar sua validade em relação à receita federal a partir da imagem frontal e traseira do documento.
\ncostumerId: identificador do cliente
\ncpf: Documento CPF identificador do indivíduo que passará pela operação
\ndocumentImage: Imagem frontal do documento do indivíduo em formato string base64
\nimageOfDocumentBack: Imagem traseira do documento do indivíduo em formato string base64
\nextraction: Objeto contendo o resultado da extração do documento, contendo os seguintes campos:
\nschemaName: Tipo de documento analisado.
\nperson: Objeto contendo informações do indivíduo como nome, data de nascimento, nome dos pais, etc.
\nmatches: Objeto contendo o resultado da comparação das informações contidas no documento com as informações armazenadas pela Receita Federal. Esse objeto conterá os campos name (nome), mothersName (nome da mãe) e birthDate (data de nascimento), que serão valores booleanos indicando se houve o match entre as informações.
\nOperação responsável pela extração de dados contidos num documento de certidão de casamento ou nascimento
\nCampos de entrada:
\ncustomerId: identificador do cliente
\ndocumentImage: Imagem do documento do indivíduo em formato string base64
\nCampos de resposta para certidões de nascimento:
\ncertificateType: Tipo de certidão.
\npersonName: Referente ao nome do indivíduo.
\nbirthDate: Referente a data de nascimento do indivíduo.
\ncpf: Documento CPF identificador do indivíduo.
\nregistration: Identificador de registro
\nfatherName: Campo referente ao nome do pai.
\nmotherName: Campo referente ao nome da mãe.
\npaternalGrandmotherName: Campo referente ao nome da avó
paterna.
maternalGrandmotherName: Campo referente ao nome da avó
materna.
paternalGrandfatherName: Campo referente ao nome de avô paterno.
\nmaternalGrandfatherName: Campo referente ao nome de avô materno.
\nwitness01Name: Referente a testemunha 01.
\nwitness02Name: Referente a testemunha 02.
\ncertificateNumber: Número de registro da certidão.
\ncertificateIssueDate: Data de emissão da certidão
\nbookNumber: Livro de registro
\npage: Página de registro
\nregistryOfficeOrCityOfRegistration: Cidade ou cartório de registro
\nCampos de resposta para certidões de casamento:
\ncertificateType: Tipo de certidão.
\nperson1Name: Referente ao nome do indivíduo 01.
\nperson2Name: Referente ao nome do indivíduo 02.
\nperson1FatherName: Campo referente ao nome do pai do indivíduo 01.
\nperson1MotherName: Campo referente ao nome da mãe do indivíduo 01.
\nperson2FatherName: Campo referente ao nome do pai do indivíduo 02.
\nperson2MotherName: Campo referente ao nome da mãe do indivíduo 02.
\nnewNamePerson1: Novo nome do indivíduo 01 após o casamento.
\nnewNamePerson2: Novo nome do indivíduo 02 após o casamento.
\nregistration: Identificador de registro.
\ncertificateNumber: Número de registro da certidão.
\ncertificateIssueDate: Data de emissão da certidão.
\nmarriageDate: Data do casamento.
\nbookNumber: Livro de registro.
\npage: Página de registro.
\nregistryOfficeOrCityOfRegistration: Cidade ou cartório de registro.
\nOperação para realizar o match de face com documento de identificação. A operação recebe uma imagem de face e uma imagem de documento e retorna se foi encontrado um match entre a biometria das imagens passadas junto com seu score de confiabilidade.
\ncostumerId: identificador do cliente
\nfaceImage: Imagem de face em formato string base64
\ndocumentImage: Imagem frontal do documento do indivíduo em formato string base64
\nmatched: Valor booleano indicando se houve o match entre a biometria facial e a imagem contida no documento.
\nscore: Nível de confiabilidade do match detectado.
\nmessage: Mensagem adicional sobre a comparação da biometria facial.
\nOperação para realizar o match de face com documento de identificação, bem como validar o documento usado. A operação retorna se foi encontrado um match entre a biometria das imagens passadas junto com seu score de confiabilidade.
\ncostumerId: identificador do cliente
\ncpf: Documento CPF identificador do indivíduo que passará pela operação
\nfaceImage: Imagem de face em formato string base64
\ndocumentImage: Imagem frontal do documento do indivíduo em formato string base64
\nimageOfDocumentBack: Imagem traseira do documento do indivíduo em formato string base64
\nstatus: Valor booleano representando o resultado da comparação biométrica e operação de OCR.
\nmessage: Mensagem adicional justificando o resultado da operação.
\nmatchDocId: Objeto referente à comparação biométrica, contendo os seguintes campos:
\nmatched: Valor booleano indicando se houve o match entre a biometria facial e a imagem contida no documento.
\nscore: Nível de confiabilidade do match detectado.
\nmessage: Mensagem adicional sobre a comparação da biometria facial.
\ndocIdScan: Objeto referente à operação de OCR, contendo os seguintes campos:
\nextraction: Resultado da extração de informações do documento, incluindo o tipo de documento identificado (RG, CNH, etc.), informações sobre o indivíduo (nome, data de nascimento, nome dos pais, etc.) e campos adicionais (cidade natal, estado natal, RG, etc.)
\ntaxData: Informações colhidas da Receita Federal, sendo elas número do documento, nome completo, nome da mãe e data de nascimento.
\nmatches: Objeto contendo o resultado da comparação das informações contidas no documento com as informações armazenadas pela Receita Federal. Esse objeto conterá os campos name (nome), mothersName (nome da mãe) e birthDate (data de nascimento), que serão valores booleanos indicando se houve o match entre as informações.
\nUsando como entrada o CPF, imagem de documento e imagem de face de um indivíduo, realiza a extração das informações do documento e compara com as informações contidas na Receita Federal para o indivíduo, realiza o teste Liveness 2D em sua imagem de face e então compara com a imagem contida no documento para averiguar a presença de match biométrico. Então, retorna o resultado das comparações.
\nCampos de entrada:
\ncostumerId: identificador do cliente
\ncpf: Documento CPF identificador do indivíduo que passará pela operação
\nfaceImage: Imagem de face em formato string base64
\ndocumentImage: Imagem frontal do documento do indivíduo em formato string base64
\nimageOfDocumentBack (opcional): Imagem traseira do documento do indivíduo em formato string base64
\nCampos de resposta:
\nstatus: Valor booleano representando o resultado da comparação biométrica, teste de Liveness e operação de OCR.
\nmessage: Mensagem adicional justificando o resultado da operação.
\nliveness2d: Campo contendo o resultado da operação de liveness.
\nmatchDocId: Objeto referente à comparação biométrica, contendo os seguintes campos:
\nmatched: Valor booleano indicando se houve o match entre a biometria facial e a imagem contida no documento.
\nscore: Nível de confiabilidade do match detectado.
\nmessage: Mensagem adicional sobre a comparação da biometria facial.
\ndocIdScan: Objeto referente à operação de OCR, contendo os seguintes campos:
\nextraction: Resultado da extração de informações do documento, incluindo o tipo de documento identificado (RG, CNH, etc.), informações sobre o indivíduo (nome, data de nascimento, nome dos pais, etc.) e campos adicionais (cidade natal, estado natal, RG, etc.)
\ntaxData: Informações colhidas da Receita Federal, sendo elas número do documento, nome completo, nome da mãe e data de nascimento.
\nmatches: Objeto contendo o resultado da comparação das informações contidas no documento com as informações armazenadas pela Receita Federal. Esse objeto conterá os campos name (nome), mothersName (nome da mãe) e birthDate (data de nascimento), que serão valores booleanos indicando se houve o match entre as informações.
\nclassification: Informações sobre o tipo de documento extraído.
\nAlém do teste contra spoofing, a operação de Liveness 2D verificará quesitos de qualidade que podem afetar o processo de análise como foco (a imagem não deve estar desfocada ou embaçada), brilho (a imagem deve apresentar um brilho adequado, não estando nem escura demais e nem clara demais) e visibilidade da face (a face do indivídio deve estar completamente visível e livre de acessórios como fones de ouvidos ou óculos, além de estar centralizada e próxima a tela).
\nCaso algum problema for detectado, ele será retornado dentro da variável result como uma string, podendo assumir os seguintes valores:
\n","urlObject":{"path":["v1","liveness-2d-match-docid-scan"],"host":["{{base-url}}"],"query":[],"variable":[]}},"response":[{"id":"04557e2d-2bff-43b2-a0a4-478cdc110932","name":"Match de face & documento + OCR + Liveness 2D (Sucesso)","originalRequest":{"method":"POST","header":[{"key":"Ocp-Apim-Subscription-Key","value":"{{api-key}}"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\r\n \"customerId\": {{customerId}},\r\n \"cpf\": {{cpf}},\r\n \"faceImage\": {{face-image}},\r\n \"documentImage\": {{document-image-front}},\r\n \"imageOfDocumentBack\": {{document-image-back}}\r\n}","options":{"raw":{"language":"json"}}},"url":"{{base-url}}/v1/liveness-2d-match-docid-scan"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": true,\n \"message\": \"Não foi identificado sinais de fraude na transação.\",\n \"liveness2d\": {\n \"processId\": {{id}},\n \"result\": \"Não identificado ataque\"\n },\n \"matchDocId\": {\n \"processId\": {{id}},\n \"face\": {\n \"matched\": true,\n \"score\": 94.86417\n },\n \"message\": \"Biometrias faciais compatíveis.\"\n },\n \"docIdScan\": {\n \"id\": {{id}},\n \"version\": \"v4\",\n \"data\": [\n {\n \"extraction\": {\n \"schemaName\": \"federalID\",\n \"person\": {\n \"taxId\": {{tax-id}},\n \"name\": {{name}},\n \"birthdate\": \"DD/MM/YYYY\",\n \"parentage\": {{parents-name}},\n \"mothersName\": null,\n \"fathersName\": null\n },\n \"otherFields\": {\n \"documentId\": {{document-id}},\n \"naturalness\": {{naturalness}},\n \"firstIssuedAt\": null,\n \"mopedsLicense\": null,\n \"driversLicenseCategory\": null,\n \"issuedAt\": \"DD/MM/YYYY\",\n \"formNumberFront\": null,\n \"formNumberBack\": null,\n \"locale\": null,\n \"securityNumber\": null,\n \"notes\": null,\n \"permission\": null,\n \"registerNumber\": null,\n \"renach\": null,\n \"expireAt\": null,\n \"sourceDocument\": null,\n \"sourceDocumentIssuer\": null,\n \"formNumber\": null,\n \"localeCity\": null,\n \"localeState\": null,\n \"nacionality\": null,\n \"state\": null,\n \"naturalnessState\": null,\n \"naturalnessCity\": null\n }\n },\n \"enhanced\": {\n \"schemaName\": \"federalID\",\n \"person\": {\n \"taxId\": {{tax-id}},\n \"name\": {{name}},\n \"birthdate\": \"YYYY-MM-DD\",\n \"parentage\": null,\n \"mothersName\": {{motherr-name}},\n \"fathersName\": {{fatherr-name}}\n },\n \"otherFields\": {\n \"documentId\": {{document-id}},\n \"naturalness\": null,\n \"firstIssuedAt\": null,\n \"mopedsLicense\": null,\n \"driversLicenseCategory\": null,\n \"issuedAt\": \"YYYY-MM-DD\",\n \"formNumberFront\": null,\n \"formNumberBack\": null,\n \"locale\": null,\n \"securityNumber\": null,\n \"notes\": null,\n \"permission\": null,\n \"registerNumber\": null,\n \"renach\": null,\n \"expireAt\": null,\n \"sourceDocument\": null,\n \"sourceDocumentIssuer\": null,\n \"formNumber\": null,\n \"localeCity\": null,\n \"localeState\": null,\n \"nacionality\": null,\n \"state\": null,\n \"naturalnessState\": \"RS\",\n \"naturalnessCity\": \"Porto Alegre\"\n }\n },\n \"taxData\": {\n \"taxId\": {{tax-id}},\n \"name\": {{name}},\n \"mothersName\": {{mother-name}},\n \"birthdate\": \"YYYY-MM-DD\"\n },\n \"matches\": {\n \"name\": true,\n \"mothersName\": false,\n \"birthdate\": true\n },\n \"classification\": {\n \"type\": \"FederalID\",\n \"subtype\": \"MainModel\",\n \"country\": \"BRA\",\n \"side\": \"FrontAndBack\",\n \"sameImage\": false\n }\n }\n ]\n }\n}"},{"id":"98655dbc-4c1e-4496-86c0-466ed95e9939","name":"Match de face & documento + OCR + Liveness 2D (Sem match biométrico)","originalRequest":{"method":"POST","header":[{"key":"Ocp-Apim-Subscription-Key","value":"{{api-key}}"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\r\n \"customerId\": {{customerId}},\r\n \"cpf\": {{cpf}},\r\n \"faceImage\": {{face-image}},\r\n \"documentImage\": {{document-image-front}},\r\n \"imageOfDocumentBack\": {{document-image-back}}\r\n}","options":{"raw":{"language":"json"}}},"url":"{{base-url}}/v1/liveness-2d-match-docid-scan"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": false,\n \"message\": \"\",\n \"liveness2d\": {\n \"processId\": {{id}},\n \"result\": \"Não identificado ataque\"\n },\n \"matchDocId\": {\n \"processId\": {{id}},\n \"face\": {\n \"matched\": false,\n \"score\": 0.038\n },\n \"message\": \"Biometrias faciais incompatíveis.\"\n }\n}"},{"id":"8825fb6d-28df-4496-9c36-c3d605ccbe70","name":"Match de face & documento + OCR + Liveness 2D (Sem match biográfico)","originalRequest":{"method":"POST","header":[{"key":"Ocp-Apim-Subscription-Key","value":"{{api-key}}"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\r\n \"customerId\": {{customerId}},\r\n \"cpf\": {{cpf}},\r\n \"faceImage\": {{face-image}},\r\n \"documentImage\": {{document-image-front}},\r\n \"imageOfDocumentBack\": {{document-image-back}}\r\n}","options":{"raw":{"language":"json"}}},"url":"{{base-url}}/v1/liveness-2d-match-docid-scan"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": false,\n \"message\": \"Não foi detectado um grau de confiança no cruzamento de dados pessoais extraídas do documento.\",\n \"liveness2d\": {\n \"processId\": {{id}},\n \"result\": \"Não identificado ataque\"\n },\n \"matchDocId\": {\n \"processId\": {{id}},\n \"face\": {\n \"matched\": true,\n \"score\": 94.86417\n },\n \"message\": \"Biometrias faciais compatíveis.\"\n },\n \"docIdScan\": {\n \"id\": {{id}},\n \"version\": \"v4\",\n \"data\": [\n {\n \"extraction\": {\n \"schemaName\": \"federalID\",\n \"person\": {\n \"taxId\": {{tax-id}},\n \"name\": {{name}},\n \"birthdate\": \"DD/MM/YYYY\",\n \"parentage\": {{parents-name}},\n \"mothersName\": null,\n \"fathersName\": null\n },\n \"otherFields\": {\n \"documentId\": {{document-id}},\n \"naturalness\": {{naturalness}},\n \"firstIssuedAt\": null,\n \"mopedsLicense\": null,\n \"driversLicenseCategory\": null,\n \"issuedAt\": \"DD/MM/YYYY\",\n \"formNumberFront\": null,\n \"formNumberBack\": null,\n \"locale\": null,\n \"securityNumber\": null,\n \"notes\": null,\n \"permission\": null,\n \"registerNumber\": null,\n \"renach\": null,\n \"expireAt\": null,\n \"sourceDocument\": null,\n \"sourceDocumentIssuer\": null,\n \"formNumber\": null,\n \"localeCity\": null,\n \"localeState\": null,\n \"nacionality\": null,\n \"state\": null,\n \"naturalnessState\": null,\n \"naturalnessCity\": null\n }\n },\n \"enhanced\": {\n \"schemaName\": \"federalID\",\n \"person\": {\n \"taxId\": {{tax-id}},\n \"name\": {{name}},\n \"birthdate\": \"YYYY-MM-DD\",\n \"parentage\": null,\n \"mothersName\": {{motherr-name}},\n \"fathersName\": {{fatherr-name}}\n },\n \"otherFields\": {\n \"documentId\": {{document-id}},\n \"naturalness\": null,\n \"firstIssuedAt\": null,\n \"mopedsLicense\": null,\n \"driversLicenseCategory\": null,\n \"issuedAt\": \"YYYY-MM-DD\",\n \"formNumberFront\": null,\n \"formNumberBack\": null,\n \"locale\": null,\n \"securityNumber\": null,\n \"notes\": null,\n \"permission\": null,\n \"registerNumber\": null,\n \"renach\": null,\n \"expireAt\": null,\n \"sourceDocument\": null,\n \"sourceDocumentIssuer\": null,\n \"formNumber\": null,\n \"localeCity\": null,\n \"localeState\": null,\n \"nacionality\": null,\n \"state\": null,\n \"naturalnessState\": \"RS\",\n \"naturalnessCity\": \"Porto Alegre\"\n }\n },\n \"taxData\": {\n \"taxId\": {{tax-id}},\n \"name\": {{name}},\n \"mothersName\": {{mother-name}},\n \"birthdate\": \"YYYY-MM-DD\"\n },\n \"matches\": {\n \"name\": false,\n \"mothersName\": false,\n \"birthdate\": false\n },\n \"classification\": {\n \"type\": \"FederalID\",\n \"subtype\": \"MainModel\",\n \"country\": \"BRA\",\n \"side\": \"FrontAndBack\",\n \"sameImage\": false\n }\n }\n ]\n }\n}"},{"id":"5f9c072d-a83a-4bcc-9f0c-28382d78d215","name":"Match de face & documento + OCR + Liveness 2D (Spoof detectado)","originalRequest":{"method":"POST","header":[{"key":"Ocp-Apim-Subscription-Key","value":"{{api-key}}"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\r\n \"customerId\": {{customerId}},\r\n \"cpf\": {{cpf}},\r\n \"faceImage\": {{face-image}},\r\n \"documentImage\": {{document-image-front}},\r\n \"imageOfDocumentBack\": {{document-image-back}}\r\n}","options":{"raw":{"language":"json"}}},"url":"{{base-url}}/v1/liveness-2d-match-docid-scan"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"status\": false,\n \"message\": \"Não foi detectado um grau de confiança seguro na imagem da Face.\",\n \"liveness2d\": {\n \"processId\": {{id}},\n \"result\": \"Ataque\"\n }\n}"},{"id":"8ea531b2-b3e8-44da-b990-6cd404aec428","name":"Match de face & documento + OCR + Liveness 2D (Qualidade de imagem inadequada)","originalRequest":{"method":"POST","header":[{"key":"Ocp-Apim-Subscription-Key","value":"{{api-key}}"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\r\n \"customerId\": {{customerId}},\r\n \"cpf\": {{cpf}},\r\n \"faceImage\": {{face-image}},\r\n \"documentImage\": {{document-image-front}},\r\n \"imageOfDocumentBack\": {{document-image-back}}\r\n}","options":{"raw":{"language":"json"}}},"url":"{{base-url}}/v1/liveness-2d-match-docid-scan"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": false,\n \"message\": \"Não foi detectado um grau de confiança seguro na imagem da Face.\",\n \"liveness2d\": {\n \"processId\": {{id}},\n \"result\": \"Face not looking directly to the camera\"\n }\n}"}],"_postman_id":"5469437d-15f5-41b8-a95d-a073cbb87296"},{"name":"Match de face & documento + OCR + documentoscopia","id":"7602f30f-7faa-47de-9d99-f8a4d8c3a6a9","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"url":"{{base-url}}/v1/match-docid-scan-inspect","description":"A partir das imagens do documento de um indivíduo e imagem de sua face, o serviço realiza a operação de match biométrico entre sua biometria facial e a face presente no documento, análise de OCR e análise de documentoscopia.
\nprocessId: Identificador da transação
\ncostumerId: identificador do cliente
\ncpf: Documento CPF identificador do indivíduo que passará pela operação
\nfaceImage: Imagem de face em formato string base64
\ndocumentImage: Imagem frontal do documento do indivíduo em formato string base64
\nimageOfDocumentBack: Imagem traseira do documento do indivíduo em formato string base64
\nstatus: Valor booleano representando o resultado da comparação biométrica, operação de OCR e documentoscopia.
\nmessage: Mensagem adicional justificando o resultado da operação.
\nmatchDocId: Objeto referente à comparação biométrica, contendo os seguintes campos:
\nmatched: Valor booleano indicando se houve o match entre a biometria facial e a imagem contida no documento.
\nscore: Nível de confiabilidade do match detectado.
\nmessage: Mensagem adicional sobre a comparação da biometria facial.
\ndocIdScan: Objeto referente à operação de OCR, contendo os seguintes campos:
\nschemaName: Tipo de documento analisado.
\nperson: Objeto contendo informações do indivíduo como nome, data de nascimento, nome dos pais, etc.
\nmatches: Objeto contendo o resultado da comparação das informações contidas no documento com as informações armazenadas pela Receita Federal. Esse objeto conterá os campos name (nome), mothersName (nome da mãe) e birthDate (data de nascimento), que serão valores booleanos indicando se houve o match entre as informações.
\nInspect: Objeto referente à operação de documentoscopia, contendo os seguintes campos:
\nscore: Nível de confiabilidade da validade do documento.
\nstatus: Resultado da análise de documentoscopia.
\nreason: Justificativa para o resultado da análise.
\nThis endpoint performs a 1:1 facial biometric match operation based on approved records. It receives a JSON message containing a CPF and a facial capture, compares it with the reference biometric data previously registered and approved in the CERTFY biometric database for that customer's CPF.
\nprocessId (optional): String representing the unique identifier of the process.
\ncustomerId (mandatory): String representing the unique identifier of the customer.
\ncpf (mandatory): String containing the individual's CPF.
\nface (mandatory): Base64 string containing the image of the facial biometric data to be verified.
\nIf the operation is successful, a response will be sent with the following fields:
\nIsGenuine: Boolean value indicating whether the individual's biometric information is compatible.
\nScore: Number indicating the similarity level between the biometrics, ranging from 0 to 100. The higher the number, the greater the compatibility.
\nThis endpoint performs a 1:1 facial biometric match operation based on approved records and the used flow. It receives a JSON message containing a CPF and a facial capture, compares it with the reference biometric data previously registered and approved in the CERTFY biometric database for that customer's CPF.
\nprocessId (optional): String representing the unique identifier of the process.
\ncustomerId (mandatory): String representing the unique identifier of the customer.
\ncpf (mandatory): String containing the individual's CPF.
\nface (mandatory): Base64 string containing the image of the facial biometric data to be verified.
\ncertificationRequestId (mandatory): Base64 string containing the request identifier.
\nIf the operation is successful, a response will be sent with the following fields:
\nIsGenuine: Boolean value indicating whether the individual's biometric information is compatible.
\nScore: Number indicating the similarity level between the biometrics, ranging from 0 to 100. The higher the number, the greater the compatibility.
\ncertificationData: String containing the flow used.
\nThis endpoint delivers 1:1 biometric match operations, being possible to perform match for facial biometrics or fingerprint biometrics. It receives a JSON message containing two biometric captures you wish to compare.
\nIf the operation is successful, the system will return a JSON message with the following fields:
\nThis endpoint performs a 1:1 facial biometric match operation. It receives a JSON message containing a Brazilian CPF and a facial capture, compares it with the reference biometrics that was previously registered in the CERTFY biometric base for this CPF of this customer.
\nIf the operation is successful, a response will be sent with the following fields:
\nOperation for checking age in an image. It receives as input a base64 image containing the face of the individual who you wish to perform the verification on.
\nIf the operation is successful, the system will return a message with the \"success\" parameter, which consists of a Boolean value that will be true if the system determines that the individual is within the age range passed in the request. It should be noted that, in addition, an image of sufficient quality must be passed for the system to be able to perform the verification.
\n","urlObject":{"path":["v1","age-check"],"host":["{{base-url}}"],"query":[],"variable":[]}},"response":[{"id":"f61e72a7-68c7-4eaf-9f2e-b1d9f4b204ef","name":"Age limit check (18 years old or above)","originalRequest":{"method":"POST","header":[{"key":"Ocp-Apim-Subscription-Key","value":"{{api-key}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"image\": \"{{face-base64-maior-de-idade}}\"\r\n}","options":{"raw":{"language":"json"}}},"url":"{{base-url}}/v1/age-check"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Ocp-Apim-Subscription-Key","value":"{{api-key}}","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"true"},{"id":"f4b09185-5b86-4a71-9873-9cad7d195965","name":"Age limit check (Below 18 years old)","originalRequest":{"method":"POST","header":[{"key":"Ocp-Apim-Subscription-Key","value":"{{api-key}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"image\": \"{{face-base64-menor-de-idade}}\"\r\n}","options":{"raw":{"language":"json"}}},"url":"{{base-url}}/v1/age-check"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Ocp-Apim-Subscription-Key","value":"{{api-key}}","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"false"},{"id":"a197a584-4368-4a93-8e49-f6e88c2f9ff8","name":"Age limit check (Invalid image format)","originalRequest":{"method":"POST","header":[{"key":"Ocp-Apim-Subscription-Key","value":"{{api-key}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"image\": \"{{face-base32}}\"\r\n}","options":{"raw":{"language":"json"}}},"url":"{{base-url}}/v1/age-check"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"key":"Ocp-Apim-Subscription-Key","value":"{{api-key}}","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"Message\": \"Imagem não é um Base64 válido!\",\n \"Errors\": null,\n \"Success\": false\n}"}],"_postman_id":"78e71e37-e0ca-484a-8042-6da7f7b2af19"},{"name":"Match & Liveness 2D","id":"d1040e1f-f185-42d8-bd9a-23e569a59df5","protocolProfileBehavior":{"disableBodyPruning":true,"disabledSystemHeaders":{"content-type":true,"host":true,"user-agent":true,"accept":true,"accept-encoding":true,"connection":true,"content-length":true}},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"{{base-url}}/v2/match-liveness","description":"Biometric match operation, which can receive two facial images and two fingerprint images to perform a 1:1 biometric comparison for each biometry passed. In addition, it performs the liveness test for the submitted image face. If desired, it is possible to perform the operation using only facial biometrics or only fingerprint biometrics. The operation receives as input the following fields:
\nIf the operation is successful, the system will return a message containing the following fields:
\nPerforms a liveness test in a biometric face capture. Receives as input the face capture in a base64 string format and returns the validation of the capture as well as the operation's confidence level.
\nInput fields:
\nResponse fields:
\nPerforms an image crop following the ICAO standard. Upon receiving an image, performs the 2D Liveness test, checks whether the image follows the standards stablished by ICAO, and then crops the image centralizing the individual's face.
\nInput fields:
\nResponse fields:
\nOperation responsible for validating facial identity based on the CPF and the image of the face (selfie). This service returns an identity confidence rank, based on biometric and documentary criteria, for use in certification processes.
\ncustomerId: Unique identifier of the requesting customer.
\ncpf: Customer's Brazilian CPF of the person to be validated. Accepts formats with or without punctuation.
\nface: Selfie image encoded in base64.
\nThe Inspect v2 service performs an image analysis of documents (front and back) and returns a final status on validation, as well as additional information on processing.
\nprocessId (optional): UUID representing the process execution. If not provided, it will be automatically generated by the system.
\ncustomerId (mandatory): Customer identifier
\nimageBack (optional): Back side of the document in base64 format.
\ncpf (mandatory): CPF of the customer to be analyzed.
\nimageFront (mandatory): Front side of the document in base64 format.
\nfinalStatus: Represents the final result of the analysis.
Possible values:
\"0\" = Approved
\n\"1\" = Rejected (e.g., conflicting data, not found in the database, etc.)
\n\"2\" = Inconclusive (cases that would be referred for manual review)
\nstatus: Indicates whether data extraction was successful.
\ntrue = Extraction completed successfully
\nfalse = An error occurred during extraction
\nmessage: Explanatory message in case of an error. Example: \"value not found\".
\nOperation responsible for returning the document analysis based on the image of a document.
\nInput Fields:
\nResponse Fields:
\nOperation responsible for extracting the information contained in a document and verifying its validity with the Brazilian Federal Revenue database using the front and back images of the document.
\nInput Fields:
\nResponse Fields:
\nOperation responsible for extracting data contained in a marriage or birth certificate document.
\nInput Fields:
\nResponse Fields for Birth Certificates:
\nResponse Fields for Marriage Certificates:
\nOperation to perform a match between a face and an identification document. The operation receives a face image and a document image, and it returns whether a match was found between the biometrics of the provided images along with a confidence score.
\nInput Fields:
\nResponse Fields:
\nOperation to perform a match between a face and an identification document, as well as validate the document used. The operation returns whether a match was found between the biometrics of the provided images along with a confidence score.
\nInput Fields:
\ncostumerId: Customer identifier.
\ncpf: CPF document identifier of the individual undergoing the operation.
\nfaceImage: Face image in base64 string format.
\ndocumentImage: Front image of the individual's document in base64 string format.
\nimageOfDocumentBack: Back image of the individual's document in base64 string format.
\nResponse Fields:
\nstatus: Boolean value representing the result of the biometric comparison and OCR operation.
\nmessage: Additional message explaining the operation result.
\nmatchDocId: Object related to biometric comparison, containing the following fields:
\nmatched: Boolean value indicating whether there was a match between the facial biometrics and the image in the document.
\nscore: Confidence level of the detected match.
\nmessage: Additional message about the facial biometric comparison.
\ndocIdScan: Object related to the OCR operation, containing the following fields:
\nextraction: Result of the document information extraction, including the identified document type (e.g., RG, CNH), information about the individual (name, date of birth, parents' names, etc.), as well as additional fields (hometown, state of origin, RG, etc.).
\ntaxData: Information retrieved from the Federal Revenue database, including Document number, Full name, Mother's name, Date of birth.
\nmatches: Object containing the comparison results between the document's information and the Federal Revenue's stored information. This object will include the fields name, mothersName and birthDate which will be Boolean values indicating whether the information provided matched.
\nUsing the CPF, document image, and face image of an individual as input, this operation extracts information from the document and compares it with the data stored in the Federal Revenue system for the individual. It performs a 2D Liveness test on the individual's face image and then compares it with the image on the document to verify the presence of a biometric match. The operation returns the comparison results.
\nInput Fields:
\ncostumerId: Customer identifier.
\ncpf: CPF document identifier of the individual undergoing the operation.
\nfaceImage: Face image in base64 string format.
\ndocumentImage: Front image of the individual's document in base64 string format.
\nimageOfDocumentBack: Back image of the individual's document in base64 string format.
\nResponse Fields:
\nstatus: Boolean value representing the result of the biometric comparison and OCR operation.
\nmessage: Additional message explaining the operation result.
\nliveness2d: Result of the liveness operation.
\nmatchDocId: Object related to biometric comparison, containing the following fields:
\nmatched: Boolean value indicating whether there was a match between the facial biometrics and the image in the document.
\nscore: Confidence level of the detected match.
\nmessage: Additional message about the facial biometric comparison.
\ndocIdScan: Object related to the OCR operation, containing the following fields:
\nextraction: Result of the document information extraction, including the identified document type (e.g., RG, CNH), information about the individual (name, date of birth, parents' names, etc.), as well as additional fields (hometown, state of origin, RG, etc.).
\ntaxData: Information retrieved from the Federal Revenue database, including Document number, Full name, Mother's name, Date of birth.
\nmatches: Object containing the comparison results between the document's information and the Federal Revenue's stored information. This object will include the fields name, mothersName and birthDate which will be Boolean values indicating whether the information provided matched.
\nclassification: Information about the extracted document.
\nIn addition to the anti-spoofing test, the 2D Liveness operation will verify quality criteria that may affect the analysis process, such as: Focus: The image should not be out of focus or blurry, Brightness: The image should have adequate brightness, neither too dark nor too bright and Face Visibility: The individual's face must be fully visible, free of accessories like headphones or glasses, and properly centered and close to the screen.
\nIf any issues are detected, they will be returned within the result variable as a string, which can take the following values:
\n","urlObject":{"path":["v1","liveness-2d-match-docid-scan"],"host":["{{base-url}}"],"query":[],"variable":[]}},"response":[{"id":"11789aca-d524-425c-b77a-3395fd0be51a","name":"Face & Document Match + OCR + 2D Liveness","originalRequest":{"method":"POST","header":[{"key":"Ocp-Apim-Subscription-Key","value":"{{api-key}}"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\r\n \"customerId\": {{customerId}},\r\n \"cpf\": {{cpf}},\r\n \"faceImage\": {{face-image}},\r\n \"documentImage\": {{document-image-front}},\r\n \"imageOfDocumentBack\": {{document-image-back}}\r\n}","options":{"raw":{"language":"json"}}},"url":"{{base-url}}/v1/liveness-2d-match-docid-scan"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": true,\n \"message\": \"Não foi identificado sinais de fraude na transação.\",\n \"liveness2d\": {\n \"processId\": {{id}},\n \"result\": \"Não identificado ataque\"\n },\n \"matchDocId\": {\n \"processId\": {{id}},\n \"face\": {\n \"matched\": true,\n \"score\": 94.86417\n },\n \"message\": \"Biometrias faciais compatíveis.\"\n },\n \"docIdScan\": {\n \"id\": {{id}},\n \"version\": \"v4\",\n \"data\": [\n {\n \"extraction\": {\n \"schemaName\": \"federalID\",\n \"person\": {\n \"taxId\": {{tax-id}},\n \"name\": {{name}},\n \"birthdate\": \"DD/MM/YYYY\",\n \"parentage\": {{parents-name}},\n \"mothersName\": null,\n \"fathersName\": null\n },\n \"otherFields\": {\n \"documentId\": {{document-id}},\n \"naturalness\": {{naturalness}},\n \"firstIssuedAt\": null,\n \"mopedsLicense\": null,\n \"driversLicenseCategory\": null,\n \"issuedAt\": \"DD/MM/YYYY\",\n \"formNumberFront\": null,\n \"formNumberBack\": null,\n \"locale\": null,\n \"securityNumber\": null,\n \"notes\": null,\n \"permission\": null,\n \"registerNumber\": null,\n \"renach\": null,\n \"expireAt\": null,\n \"sourceDocument\": null,\n \"sourceDocumentIssuer\": null,\n \"formNumber\": null,\n \"localeCity\": null,\n \"localeState\": null,\n \"nacionality\": null,\n \"state\": null,\n \"naturalnessState\": null,\n \"naturalnessCity\": null\n }\n },\n \"enhanced\": {\n \"schemaName\": \"federalID\",\n \"person\": {\n \"taxId\": {{tax-id}},\n \"name\": {{name}},\n \"birthdate\": \"YYYY-MM-DD\",\n \"parentage\": null,\n \"mothersName\": {{motherr-name}},\n \"fathersName\": {{fatherr-name}}\n },\n \"otherFields\": {\n \"documentId\": {{document-id}},\n \"naturalness\": null,\n \"firstIssuedAt\": null,\n \"mopedsLicense\": null,\n \"driversLicenseCategory\": null,\n \"issuedAt\": \"YYYY-MM-DD\",\n \"formNumberFront\": null,\n \"formNumberBack\": null,\n \"locale\": null,\n \"securityNumber\": null,\n \"notes\": null,\n \"permission\": null,\n \"registerNumber\": null,\n \"renach\": null,\n \"expireAt\": null,\n \"sourceDocument\": null,\n \"sourceDocumentIssuer\": null,\n \"formNumber\": null,\n \"localeCity\": null,\n \"localeState\": null,\n \"nacionality\": null,\n \"state\": null,\n \"naturalnessState\": \"RS\",\n \"naturalnessCity\": \"Porto Alegre\"\n }\n },\n \"taxData\": {\n \"taxId\": {{tax-id}},\n \"name\": {{name}},\n \"mothersName\": {{mother-name}},\n \"birthdate\": \"YYYY-MM-DD\"\n },\n \"matches\": {\n \"name\": true,\n \"mothersName\": false,\n \"birthdate\": true\n },\n \"classification\": {\n \"type\": \"FederalID\",\n \"subtype\": \"MainModel\",\n \"country\": \"BRA\",\n \"side\": \"FrontAndBack\",\n \"sameImage\": false\n }\n }\n ]\n }\n}"},{"id":"7acd7da0-cf04-4376-bfb2-d0b8eb3bf3c3","name":"Face & Document Match + OCR + 2D Liveness (No biometric match)","originalRequest":{"method":"POST","header":[{"key":"Ocp-Apim-Subscription-Key","value":"{{api-key}}"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\r\n \"customerId\": {{customerId}},\r\n \"cpf\": {{cpf}},\r\n \"faceImage\": {{face-image}},\r\n \"documentImage\": {{document-image-front}},\r\n \"imageOfDocumentBack\": {{document-image-back}}\r\n}","options":{"raw":{"language":"json"}}},"url":"{{base-url}}/v1/liveness-2d-match-docid-scan"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": false,\n \"message\": \"\",\n \"liveness2d\": {\n \"processId\": {{id}},\n \"result\": \"Não identificado ataque\"\n },\n \"matchDocId\": {\n \"processId\": {{id}},\n \"face\": {\n \"matched\": false,\n \"score\": 0.038\n },\n \"message\": \"Biometrias faciais incompatíveis.\"\n }\n}"},{"id":"8dee048d-d641-4369-81ec-c7bcc4e74413","name":"Face & Document Match + OCR + 2D Liveness (No biographic match)","originalRequest":{"method":"POST","header":[{"key":"Ocp-Apim-Subscription-Key","value":"{{api-key}}"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\r\n \"customerId\": {{customerId}},\r\n \"cpf\": {{cpf}},\r\n \"faceImage\": {{face-image}},\r\n \"documentImage\": {{document-image-front}},\r\n \"imageOfDocumentBack\": {{document-image-back}}\r\n}","options":{"raw":{"language":"json"}}},"url":"{{base-url}}/v1/liveness-2d-match-docid-scan"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": false,\n \"message\": \"Não foi detectado um grau de confiança no cruzamento de dados pessoais extraídas do documento.\",\n \"liveness2d\": {\n \"processId\": {{id}},\n \"result\": \"Não identificado ataque\"\n },\n \"matchDocId\": {\n \"processId\": {{id}},\n \"face\": {\n \"matched\": true,\n \"score\": 94.86417\n },\n \"message\": \"Biometrias faciais compatíveis.\"\n },\n \"docIdScan\": {\n \"id\": {{id}},\n \"version\": \"v4\",\n \"data\": [\n {\n \"extraction\": {\n \"schemaName\": \"federalID\",\n \"person\": {\n \"taxId\": {{tax-id}},\n \"name\": {{name}},\n \"birthdate\": \"DD/MM/YYYY\",\n \"parentage\": {{parents-name}},\n \"mothersName\": null,\n \"fathersName\": null\n },\n \"otherFields\": {\n \"documentId\": {{document-id}},\n \"naturalness\": {{naturalness}},\n \"firstIssuedAt\": null,\n \"mopedsLicense\": null,\n \"driversLicenseCategory\": null,\n \"issuedAt\": \"DD/MM/YYYY\",\n \"formNumberFront\": null,\n \"formNumberBack\": null,\n \"locale\": null,\n \"securityNumber\": null,\n \"notes\": null,\n \"permission\": null,\n \"registerNumber\": null,\n \"renach\": null,\n \"expireAt\": null,\n \"sourceDocument\": null,\n \"sourceDocumentIssuer\": null,\n \"formNumber\": null,\n \"localeCity\": null,\n \"localeState\": null,\n \"nacionality\": null,\n \"state\": null,\n \"naturalnessState\": null,\n \"naturalnessCity\": null\n }\n },\n \"enhanced\": {\n \"schemaName\": \"federalID\",\n \"person\": {\n \"taxId\": {{tax-id}},\n \"name\": {{name}},\n \"birthdate\": \"YYYY-MM-DD\",\n \"parentage\": null,\n \"mothersName\": {{motherr-name}},\n \"fathersName\": {{fatherr-name}}\n },\n \"otherFields\": {\n \"documentId\": {{document-id}},\n \"naturalness\": null,\n \"firstIssuedAt\": null,\n \"mopedsLicense\": null,\n \"driversLicenseCategory\": null,\n \"issuedAt\": \"YYYY-MM-DD\",\n \"formNumberFront\": null,\n \"formNumberBack\": null,\n \"locale\": null,\n \"securityNumber\": null,\n \"notes\": null,\n \"permission\": null,\n \"registerNumber\": null,\n \"renach\": null,\n \"expireAt\": null,\n \"sourceDocument\": null,\n \"sourceDocumentIssuer\": null,\n \"formNumber\": null,\n \"localeCity\": null,\n \"localeState\": null,\n \"nacionality\": null,\n \"state\": null,\n \"naturalnessState\": \"RS\",\n \"naturalnessCity\": \"Porto Alegre\"\n }\n },\n \"taxData\": {\n \"taxId\": {{tax-id}},\n \"name\": {{name}},\n \"mothersName\": {{mother-name}},\n \"birthdate\": \"YYYY-MM-DD\"\n },\n \"matches\": {\n \"name\": false,\n \"mothersName\": false,\n \"birthdate\": false\n },\n \"classification\": {\n \"type\": \"FederalID\",\n \"subtype\": \"MainModel\",\n \"country\": \"BRA\",\n \"side\": \"FrontAndBack\",\n \"sameImage\": false\n }\n }\n ]\n }\n}"},{"id":"e0f5736b-da09-4c86-9a2f-847ffbcb3521","name":"Face & Document Match + OCR + 2D Liveness (Spoof detected)","originalRequest":{"method":"POST","header":[{"key":"Ocp-Apim-Subscription-Key","value":"{{api-key}}"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\r\n \"customerId\": {{customerId}},\r\n \"cpf\": {{cpf}},\r\n \"faceImage\": {{face-image}},\r\n \"documentImage\": {{document-image-front}},\r\n \"imageOfDocumentBack\": {{document-image-back}}\r\n}","options":{"raw":{"language":"json"}}},"url":"{{base-url}}/v1/liveness-2d-match-docid-scan"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"status\": false,\n \"message\": \"Não foi detectado um grau de confiança seguro na imagem da Face.\",\n \"liveness2d\": {\n \"processId\": {{id}},\n \"result\": \"Ataque\"\n }\n}"},{"id":"c33713da-cb39-4601-ae35-e75ec15ff647","name":"Face & Document Match + OCR + 2D Liveness (Low quality image)","originalRequest":{"method":"POST","header":[{"key":"Ocp-Apim-Subscription-Key","value":"{{api-key}}"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\r\n \"customerId\": {{customerId}},\r\n \"cpf\": {{cpf}},\r\n \"faceImage\": {{face-image}},\r\n \"documentImage\": {{document-image-front}},\r\n \"imageOfDocumentBack\": {{document-image-back}}\r\n}","options":{"raw":{"language":"json"}}},"url":"{{base-url}}/v1/liveness-2d-match-docid-scan"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": false,\n \"message\": \"Não foi detectado um grau de confiança seguro na imagem da Face.\",\n \"liveness2d\": {\n \"processId\": {{id}},\n \"result\": \"Face not looking directly to the camera\"\n }\n}"}],"_postman_id":"b3c8adbf-dc90-4928-83b5-a2a0b167d2b9"},{"name":"Face & Document Match + OCR + Documentoscopy","id":"7b524f8f-71b7-479d-8ad0-c33f3701e192","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"url":"{{base-url}}/v1/match-docid-scan-inspect","description":"From the images of an individual's document and face, the service performs a biometric match operation between their facial biometrics and the face on the document, OCR analysis, and documentoscopy analysis.
\nInput Fields:
\nResponse Fields:
\n