API Reference

Runs an evaluation

post
https://sandbox.alloy.co/v1/evaluations

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.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
Headers
string

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).

string

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.

string

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

string

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

string

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

string
enum

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

Allowed:
boolean

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

boolean

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

Responses

Updated 6 months ago

Language
Credentials
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 6 months ago