Verification request bodies
Default fields for all webhooks:
| Field Name | Value Type | Details |
|---|---|---|
| unit21_id | Number | A Unit21 internally-assigned unique identifier for the entity within our system |
| entity_id | String | The ID of the matching entity within your system |
| object_type | String | Always takes on the value ENTITY for entity webhooks |
| change | String | A Unit21-defined value describing the nature of the change to this entity. For more details on this, see above section Change trigger types |
| change_time | Number | Time the change was triggered in Epoch time format (number of seconds elapsed since 1 Jan 1970 00:00:00 UTC) |
Additional fields for VERIFICATION_WORKFLOW_EXECUTED:**
Sample JSON response:
{
"unit21_id": 1,
"entity_id": "external_id",
"object_type": "ENTITY",
"change": "VERIFICATION_WORKFLOW_EXECUTED",
"verification_workflow_id": "test-workflow",
"result": "$ACCEPT",
"change_time": 123123123,
"is_success": true,
"generated_alert": 123,
"tags": []
}
| Field Name | Value Type | Details |
|---|---|---|
| verification_workflow_id | String | Identifier for the verification workflow executed for the entity |
| result | String | Terminal state for the workflow E.g: $ACCEPT, $REJECT, etc. |
| is_success | Boolean | Boolean for whether or not the workflow executed without errors |
| generated_alert | Number | ID for the alert generated by this workflow if the execution finished in a terminal state marked with Generate Alert |
| tags | String[] | A list of tags that are associated with this entity, always of the format key:value |
Additional fields for VERIFICATION_ENTITY_INITIATED:
Sample JSON response
{
"unit21_id": 1,
"entity_id": "external_id",
"object_type": "ENTITY",
"change": "VERIFICATION_ENTITY_INITIATED",
"verification_workflow_id": "test-workflow"
}
| Field Name | Value Type | Details |
|---|---|---|
| verification_workflow_id | String | Identifier for the verification workflow executed for the entity |
Additional fields for VERIFICATION_ENTITY_STEP_COMPLETED:
Sample JSON response:
{
"unit21_id": 1,
"entity_id": "external_id",
"object_type": "ENTITY",
"change": "VERIFICATION_ENTITY_STEP_COMPLETED",
"verification_workflow_id": "test-workflow",
"content": { "some_field": "some_value" },
"step": "PROVIDER:TYPE",
"change_time": 123123123
}
| Field Name | Value Type | Details |
|---|---|---|
| verification_workflow_id | String | Identifier for the verification workflow executed for the entity |
| content | Object | Raw JSON response from the provider. Shape depends on the provider executed in this step |
| step | String | Name of the step completed. Represented as PROVIDER:TYPE. E.G. IDOLOGY:ID_VERIFICATION |