Score
The Score module performs synchronous analysis of the received data, returning score and status within seconds.
How the Score Module Works
Score Module WorksThe score module operates synchronously, analyzing the data immediately after receiving a request. This process involves cross-referencing multiple relevant pieces of information to calculate the score and determine the status of the request.
The analysis response is returned within seconds, enabling fast decisions that are integrated into the application's flow, without the need for asynchronous processing or prolonged waiting.
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 |
| decision | Decision result | Decision Result | No |
Decision Result
Represents the result of a decision.
| Field | Description | Type | Required |
|---|---|---|---|
| status | Decision status | String | Yes |
| score | Score associated with decision | Float | No |
JSON
{
"executionId": "string",
"analysisId": "string",
"transactionId": "string",
"decision": {
"status": "string",
"score": 0.85
}
}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 |
| decision | Decision result | Decision Result | No |
Decision Result
Represents the result of a decision.
| Field | Description | Type | Required |
|---|---|---|---|
| status | Decision status | String | Yes |
| score | Score associated with decision | Float | No |
JSON
{
"analysisId": "string",
"transactionId": "string",
"decision": {
"status": "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 |
HTTP Status Codes
Represents the possible HTTP codes returned by the API in case of an error.
| Code | Name | Meaning |
|---|---|---|
| 400 | Bad Request | The request was malformed or contains invalid parameters |
| 401 | Unauthorized | The client is not authenticated or the token is invalid/expired |
| 500 | Internal Server Error | An unexpected error occurred on the server |
| 503 | Service Unavailable | The service is temporarily unavailable or under maintenance |
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