Runs an evaluation
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.
Headers
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).
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.
If running an additional evaluation for an existing entity - the existing entity token can be provided to connect the new evaluation to the entity.
A string to identify the entity created by the evaluation in your system.
A token of an entity to be used as a parent entity.
For transactions workflows, specifies whether the entity associated with the evaluation is a business or person entity. Defaults to person.
Optional boolean value, required to be true for using counterparty sanction screening in a transaction workflow.
Optional boolean value, required to be true for using source entity sanction screening in a transaction workflow.
Parameters
Request body
Response
Evaluation missing required inputs
Example response
{
"required": [
{
"key": "name_first",
"type": "string",
"description": "First name",
"regex": "^[^d]*$"
}
],
"optional": [
{
"key": "email_address",
"type": "string",
"description": "Email address"
}
]
}Changes
No recorded changes to this endpoint across all 1 revision of this API.