Biolink
The Biolink module performs asynchronous analysis of the received data for more comprehensive validation.
How the Biolink Module Works
Biolink Module WorksThe Biolink module performs its analysis asynchronously, processing data in the background without impacting the main application flow. During this process, various relevant pieces of information are cross-referenced, including identity validation of the customer who made the purchase.
For triggering the Biolink message, the fields Name and Transaction Value are mandatory.
The analysis response can be checked later, allowing the system to make decisions based on the results as soon as they are available.
Response POST
Represents the integration execution response. If you have contracted more than one module, you may receive all at once. Modules not contracted will not be returned.
Result
| Field | Description | Type | Required |
|---|---|---|---|
| executionId | Execution ID | Guid | Yes |
| analysisId | Analysis ID | Guid | Yes |
| transactionId | Transaction ID | String | Yes |
| biolink | Biolink result | Biolink Result | No |
Biolink Result
Represents the result of a biometric analysis.
| Field | Description | Type | Required |
|---|---|---|---|
| status | Analysis status | String | Yes |
| score | Biometric analysis score | Double | No |
JSON
{
"executionId": "string",
"analysisId": "string",
"transactionId": "string",
"biolink": {
"status": "string",
"score": 0,
}Response GET
Represents the execution response of the analysis query.
Result
| Field | Description | Type | Required |
|---|---|---|---|
| analysisId | Analysis ID | Guid | Yes |
| transactionId | Transaction ID | String | Yes |
| biolink | Biolink result | Biolink Result | No |
Biolink Result
Represents the result of a biometric analysis.
| Field | Description | Type | Required |
|---|---|---|---|
| status | Analysis status | String | Yes |
| identifierId | Identification ID | String | Sim |
| score | Biometric analysis score | Double | No |
JSON
{
"analysisId": "string",
"transactionId": "string",
"biolink": {
"status": "string",
"identifierId": "string",
"score": 0
}
}Response Error
Represents the details of a problem returned by the API in case of error.
| Field | Description | Type | Required |
|---|---|---|---|
| type | URI identifying the specific problem type. Can be used to categorize the error. | String | No |
| title | Descriptive title of the problem | String | Yes |
| status | HTTP status code associated with the problem | Integer | Yes |
| errors | Validation errors | Object | Yes |
| instance | URI identifying the specific instance of the problem | String | No |
JSON
{
"errors": {
"string": [
"string"
]
},
"type": "string",
"title": "string",
"status": 0,
"traceId": "string"
}Updated 20 days ago