Decision

The Decision module performs synchronous analyses of the received data, returning a score and status within seconds.

How the Decision Module Works

The Decision 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, determine the status, and the result of the request.

The analysis response is returned within seconds, enabling fast decisions 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. What is not contracted will not be returned.


Result

FieldsDescriptionTypeRequired
executionIdExecution IDGuidYes
analysisIdAnalysis IDGuidYes
transactionIdTransaction IDStringYes
decisionDecision resultDecision ResultNo

Decision Result

Represents the result of a decision.

FieldsDescriptionTypeRequired
statusDecision statusStringYes
scoreScore associated with the decisionFloatNo
resultDecision resultStringNo
metadataAdditional metadataObjectNo

JSON

{
  "executionId": "string",
  "analysisId": "string",
  "transactionId": "string",
  "decision": {
    "status": "string",
    "score": 0,
    "result": "string",
    "metadata": {}
  }
}

Response GET

Represents the execution response of the analysis query.


Result

FieldsDescriptionTypeRequired
analysisIdAnalysis IDGuidYes
transactionIdTransaction IDStringYes
decisionDecision resultDecision ResultNo

Decision Result

Represents the result of a decision.

FieldsDescriptionTypeRequired
statusDecision statusStringYes
scoreScore associated with the decisionFloatNo
resultDecision resultStringNo

JSON

{
  "analysisId": "string",
  "transactionId": "string",
  "decision": {
    "status": "string",
    "score": 0,
    "result": "string"
  }
}

Response Error

Represents the details of a problem returned by the API in case of error.

FieldsDescriptionTypeRequired
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 problem instanceStringNo

JSON

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