Sign in

v1

latestOpenAPI 3.0.02026-07-241220330.3 KB
Events

Create an event

post/events/

Request body

event_type'person_created' | 'person_updated' | 'business_created' | 'business_updated' | 'bank_account_created' | 'bank_account_updated' | 'external_account_created' | 'external_account_updated' | 'transaction' | 'login' | 'credentials_updated' | 'embedded_authentication' | 'modify_notification' | 'entity_group_created' | 'entity_group_updated' | 'card_created' | 'card_updated' required
external_event_idstring
event_statusstring

Event statuses are customer-defined values.

Response

Event has been processed

status_codestring
errorobject

error details

Example response

{
  "status_code": 201,
  "event_request_token": "EV-xi7Etep0gW7gZiuWsqXG",
  "_links": {
    "self": {
      "href": "/v1/events/EV-xi7Etep0gW7gZiuWsqXG"
    }
  },
  "event": {
    "event_type": "person_created",
    "event_status": "PROCESSED",
    "data": {
      "entity_token": "P-R21gUOQ8rwCvmx8tIscf",
      "external_entity_id": "087ac67e-17ab-4529-8d1a-a8b2214d305f",
      "created_at": 1701878665579,
      "person_details_updated_at": 1701878665619,
      "gender": null,
      "birth_date": null,
      "name_first": "John",
      "name_middle": null,
      "name_last": "Smith",
      "document_ssn": null,
      "document_license": null,
      "document_passport": null,
      "addresses": [],
      "emails": [],
      "phones": [],
      "type": "person",
      "_embedded": {
        "document_ssns": [],
        "birth_dates": []
      },
      "_links": {
        "self": {
          "href": "/v1/entities/persons/P-R21gUOQ8rwCvmx8tIscf"
        }
      }
    },
    "evaluations": [
      {
        "error": null,
        "evaluation_token": "L-Ro4OHzXIkRVf4J9z0aAA",
        "workflow_token": "token",
        "workflow_version_id": 8,
        "prefiltered": false,
        "summary": {
          "result": "success",
          "outcome": "Approved",
          "tags": []
        },
        "_links": {
          "self": {
            "href": "/v1/evaluations/L-Ro4OHzXIkRVf4J9z0aAA"
          }
        }
      }
    ],
    "journey_applications": [
      {
        "error": null,
        "journey_application_token": "JA-s2cgOok19WgykpSqcm29",
        "journey_token": "J-JrtCVvSP1iUDhJy3xtCp",
        "journey_version_id": 5,
        "source_evaluation_tokens": [
          "L-Ro4OHzXIkRVf4J9z0aAA"
        ],
        "investigations": [
          {
            "investigation_token": "INV-gBg9JCX0AoSWjer5zU0o",
            "investigation_state": "alert_review"
          }
        ],
        "_links": {
          "self": {
            "href": "/v1/journeys/J-JrtCVvSP1iUDhJy3xtCp/applications/JA-s2cgOok19WgykpSqcm29"
          }
        }
      }
    ]
  }
}