Score

The Score module performs synchronous analysis of the received data, returning score and status within seconds.

How the Score Module Works

The 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

FieldDescriptionTypeRequired
executionIdExecution IDGuidYes
analysisIdAnalysis IDGuidYes
transactionIdTransaction IDStringYes
decisionDecision resultDecision ResultNo

Decision Result

Represents the result of a decision.

FieldDescriptionTypeRequired
statusDecision statusStringYes
scoreScore associated with decisionFloatNo

JSON

{
  "executionId": "string",
  "analysisId": "string",
  "transactionId": "string",
  "decision": {
    "status": "string",
    "score": 0.85    
  }
}

Response GET

Represents the execution response of the analysis query.


Result

FieldDescriptionTypeRequired
analysisIdAnalysis IDGuidYes
transactionIdTransaction IDStringYes
decisionDecision resultDecision ResultNo

Decision Result

Represents the result of a decision.

FieldDescriptionTypeRequired
statusDecision statusStringYes
scoreScore associated with decisionFloatNo

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.

FieldDescriptionTypeRequired
typeURI identifying the specific problem type. Can be used to categorize the error.StringNo
titleDescriptive title of the problemStringYes
statusHTTP status code associated with the problemIntegerYes
errorsValidation errorsObjectYes
instanceURI identifying the specific instance of the problemStringNo

JSON

{
  "errors": {
    "string": [
      "string"
    ]
  },
  "type": "string",
  "title": "string",
  "status": 0,
  "traceId": "string"
}