ALalloy
Evaluations

Runs an evaluation

Changed on

Given a workflow specified by the header, the API will run an evaluation with the provided payload. Alloy's API is dynamic, and thus the input parameters vary depending on which services are run and how the workflow is configured.

post/evaluations

Request

Headers

Authorizationstring

Basic authorization header per the OAuth Client Authorization Header standard.

The format is Basic <auth_string>, where <auth_string> is the base64 encoding of the string token:secret (check Authentication Guide for details).

alloy-workflow-tokenstring

If you have migrated to the new API Key Settings page and are using account-level API keys for authentication, this header is required to specify which workflow to use for the evaluation.

If you have not migrated yet, this header is optional, as the workflow will be determined by the Authorization header using workflow_token.

alloy-entity-tokenstring

If running an additional evaluation for an existing entity - the existing entity token can be provided to connect the new evaluation to the entity.

alloy-external-entity-idstring

A string to identify the entity created by the evaluation in your system.

alloy-parent-entity-tokenstring

A token of an entity to be used as a parent entity.

alloy-entity-type'business' | 'person'

For transactions workflows, specifies whether the entity associated with the evaluation is a business or person entity. Defaults to person.

alloy-hydrate-counterparty-databoolean

Optional boolean value, required to be true for using counterparty sanction screening in a transaction workflow.

alloy-hydrate-entity-databoolean

Optional boolean value, required to be true for using source entity sanction screening in a transaction workflow.

alloy-sandbox-persona-tokenstring

Instead of using the configured business and person identifier (for example, the last name DenyFraud), this header references the corresponding sandbox profile/persona using its sandbox profile token, found on the Sandbox Profile page.

Example:E-tSXbp2UBPwiA5a9wsBwN

Request body

EvaluationBody required
OR

Example request

{
  "source": {
    "external_account_id": "test-account-001",
    "account_class": "deposit",
    "entities": [
      {
        "external_entity_id": "entity-01",
        "account_holder_type": "primary"
      }
    ],
    "account_snapshot": {
      "timestamp": "2022-03-21T21:50:07.623Z",
      "details": {
        "status": "Active"
      }
    }
  },
  "destination": {
    "external_account_id": "test-account-001",
    "account_class": "deposit",
    "entities": [
      {
        "external_entity_id": "entity-01",
        "account_holder_type": "primary"
      }
    ],
    "account_snapshot": {
      "timestamp": "2022-03-21T21:50:07.623Z",
      "details": {
        "status": "Active"
      }
    }
  }
}

Response

Evaluation missing required inputs

status_codestring
errorobject
timestampnumber
evaluation_tokenstring
entity_tokenstring
application_tokenstring
application_version_idnumber

Example response

{
  "required": [
    {
      "key": "name_first",
      "type": "string",
      "description": "First name",
      "regex": "^[^d]*$"
    }
  ],
  "optional": [
    {
      "key": "email_address",
      "type": "string",
      "description": "Email address"
    }
  ]
}

Changes

  • 615aa97a5ddbRevision changes
    • breaking

      removed subschema #2: Transaction Evaluation Body from the request body oneOf list

    • info

      added to the request body oneOf list