Verification Webhooks

Verification request bodies

Default fields for all webhooks:

Field NameValue TypeDetails
unit21_idNumberA Unit21 internally-assigned unique identifier for the entity within our system
entity_idStringThe ID of the matching entity within your system
object_typeStringAlways takes on the value ENTITY for entity webhooks
changeStringA Unit21-defined value describing the nature of the change to this entity. For more details on this, see above section Change trigger types
change_timeNumberTime 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 NameValue TypeDetails
verification_workflow_idStringIdentifier for the verification workflow executed for the entity
resultStringTerminal state for the workflow E.g: $ACCEPT, $REJECT, etc.
is_successBooleanBoolean for whether or not the workflow executed without errors
generated_alertNumberID for the alert generated by this workflow if the execution finished in a terminal state marked with Generate Alert
tagsString[]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 NameValue TypeDetails
verification_workflow_idStringIdentifier 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 NameValue TypeDetails
verification_workflow_idStringIdentifier for the verification workflow executed for the entity
contentObjectRaw JSON response from the provider. Shape depends on the provider executed in this step
stepStringName of the step completed. Represented as PROVIDER:TYPE. E.G. IDOLOGY:ID_VERIFICATION