Biolink
O módulo Biolink realiza análises assíncronas dos dados recebidos, para uma validação mais completa.
Funcionamento do Módulo Biolink
BiolinkO módulo Biolink realiza suas análises de forma assíncrona, processando os dados em segundo plano sem impactar o fluxo principal da aplicação. Durante esse processo, diversas informações relevantes são cruzadas, incluindo a validação de identidade do cliente que realizou a compra.
Para o disparo de Biolink, os campos de Nome e Valor do Pedido (transactionValue) são obrigatórios na requisição.
A resposta da análise pode ser consultada posteriormente, permitindo que o sistema tome decisões com base nos resultados assim que estiverem disponíveis.
POST Response
Representa a resposta de execução da integração no módulo de Biolink. Caso tenha contratado mais de um módulo, pode receber todos de uma vez. O que não tiver contratado, não será retornado.
Result
| Campos | Descrição | Tipo | Obrigatório |
|---|---|---|---|
| executionId | ID da execução | Guid | Sim |
| analysisId | ID da análise | Guid | Sim |
| transactionId | ID da transação | String | Sim |
| biolink | Resultado do Biolink | Biolink Result | Não |
Biolink Result
Representa o resultado de uma análise biométrica.
| Campos | Descrição | Tipo | Obrigatório |
|---|---|---|---|
| status | Status da análise | String | Sim |
| score | Pontuação da análise biométrica | Double | Não |
JSON
{
"executionId": "string",
"analysisId": "string",
"transactionId": "string",
"biolink": {
"status": "string",
"score": 0,
}GET Response
Representa a resposta de execução da consulta da análise.
Result
| Campos | Descrição | Tipo | Obrigatório |
|---|---|---|---|
| analysisId | ID da análise | Guid | Sim |
| transactionId | ID da transação | String | Sim |
| biolink | Resultado do Biolink | Biolink Result | Não |
Biolink Result
Representa o resultado de uma análise biométrica.
| Campos | Descrição | Tipo | Obrigatório |
|---|---|---|---|
| status | Status da análise | String | Sim |
| identifierId | ID da identificação | String | Sim |
| score | Pontuação da análise biométrica | Double | Não |
JSON
{
"analysisId": "string",
"transactionId": "string",
"biolink": {
"status": "string",
"identifierId": "string",
"score": 0
}
}Response com erro
Representa os detalhes de um problema retornado pela API em caso de erro.
| Campos | Descrição | Tipo | Obrigatório |
|---|---|---|---|
| type | URI que identifica o tipo de problema específico. Pode ser usado para categorizar o erro. | String | Não |
| title | Título descritivo do problema | String | Sim |
| status | Código de status HTTP associado ao problema | Integer | Sim |
| errors | Erros de validação | Object | Sim |
| instance | URI que identifica a instância específica do problema | String | Não |
Tabela de Códigos HTTP
Representa os possíveis códigos HTTP de um problema retornado pela API em caso de erro.
| Código | Nome | Significado |
|---|---|---|
| 400 | Bad Request | A requisição foi malformada ou contém parâmetros inválidos |
| 401 | Unauthorized | O cliente não está autenticado ou o token é inválido/expirado |
| 500 | Internal Server Error | Erro inesperado no servidor |
| 503 | Service Unavailable | O serviço está temporariamente indisponível ou em manutenção |
JSON
{
"errors": {
"string": [
"string"
]
},
"type": "https://tools.ietf.org/html/rfc9110#section-15.5.1",
"title": "One or more validation errors occurred.",
"status": 400,
"traceId": "string"
}
{
"type": "https://tools.ietf.org/html/rfc7231#section-6.5.1",
"title": "Internal server error",
"status": 500,
"detail": "The server encountered an unexpected condition that prevented it from fulfilling the request",
"traceId": "string"
}Updated about 2 months ago