Skip to main content
​
type
enum<string>
required

The type property determines the type of the event. It follows the APPLICATION_<STATUS> naming convention, indicating that events are emitted whenever there is a change in the application status:

  • "APPLICATION_SUBMITTED" # (Optional) The application has been submitted and received.
  • "APPLICATION_KYC" # (Required) The application is in the KYC (Know Your Customer) status. Additional user information may be required to advance.
  • "APPLICATION_MANUAL_REVIEW" # (Optional) The application is under manual review.
  • "APPLICATION_APPROVED" # (Required) The application has been approved. An account can be created for the user. This is a final state.
  • "APPLICATION_REJECTED" # (Required) The application has been rejected. No account was created for the user. This is a final state.
  • "APPLICATION_EXPIRED" # (Optional) The application has expired. No account was created for the user. This is a final state.
Status changes only occur from a previous state to a subsequent state in the list. For example, an application can transition from `SUBMITTED` to `KYC` or `APPROVED`. Once a state is reached, it cannot move back to a previous state. Which event types a program actually emits depends on its KYC workflow and banking partner. Handle any type in this list, and do not depend on a specific one arriving.
Available options:
APPLICATION_SUBMITTED,
APPLICATION_KYC,
APPLICATION_MANUAL_REVIEW,
APPLICATION_APPROVED,
APPLICATION_REJECTED,
APPLICATION_EXPIRED
Example:

"APPLICATION_KYC"

​
data
object
required

The unencrypted data JSON value for APPLICATION event types.

​
idempotency_key
string
required

A unique identifier for the event, generated by the sender and unique for each event. This value is used to ensure that the event is processed only once by the receiving platform.

Example:

"16c4fb2d-3321-46b3-acf6-567ceba2d3fc"

​
reason
object

Describes the reason why the operation was not successfully executed. The reason value should be present in all error responses and events.

​
timestamp
string<date-time>

The timestamp of the event, in the format defined by RFC 3339, section 5.6. The latest event timestamp must coincide with the updated_on value from the Application.

Example:

"2021-09-01T12:00:00Z"