User

Event	Trigger
user:created	User created a new account.
user:logged-in	User logged in.
user:kyc:identity:initiated	User's KYC identity process has been initiated.
user:kyc:identity:succeeded	User's KYC identity process has succeeded.
user:kyc:identity:failed	User's KYC identity process has failed.

user:created

Triggered when a new user is created.

Schema

• user: User object.
  • id: UUID of the user.
  • createdAt: Timestamp at which the user was created.

Example

{
  "name": "user:created",
  "id": "00a991cf-a870-43af-88b8-43c51532831d",
  "bootstrapTokenId": "141bfa06-481e-4684-96eb-cec4ad529616",
  "data": {
    "user": {
      "id": "b9fe022b-f436-49e1-bb89-6f2e8eabf336",
      "createdAt": "2023-06-12T17:21:21.240Z"
    }
  }
}

user:logged-in

Triggered when a user logs in.

Schema

• authenticationMethod: Authentication method used (otp or sso).
• user: User object.
  • id: UUID of the user.
  • confirmedAt: Timestamp at which the user was confirmed.

Example

{
  "name": "user:logged-in",
  "id": "00a991cf-a870-43af-88b8-43c51532831d",
  "bootstrapTokenId": "141bfa06-481e-4684-96eb-cec4ad529616",
  "data": {
    "authenticationMethod": "otp",
    "user": {
      "id": "b9fe022b-f436-49e1-bb89-6f2e8eabf336",
      "confirmedAt": "2023-06-12T17:21:21.240Z"
    }
  }
}

user:kyc:identity:initiated

Triggered when a user's KYC process has been initiated.

Schema

• kycSession: KYC session object.
  • initiatedAt: Timestamp at which the KYC session was initiated.
• user: User object.
  • id: UUID of the user.

Example

{
  "name": "user:kyc:identity:initiated",
  "id": "00a991cf-a870-43af-88b8-43c51532831d",
  "bootstrapTokenId": "141bfa06-481e-4684-96eb-cec4ad529616",
  "data": {
    "kycSession": {
      "initiatedAt": "2024-01-15T10:30:00.000Z"
    },
    "user": {
      "id": "b9fe022b-f436-49e1-bb89-6f2e8eabf336"
    }
  }
}

user:kyc:identity:succeeded

Triggered when a user's KYC process has succeeded.

Schema

• kycSession: KYC session object.
  • updatedAt: Timestamp at which the KYC session was last updated.
• user: User object.
  • id: UUID of the user.

Example

{
  "name": "user:kyc:identity:succeeded",
  "id": "00a991cf-a870-43af-88b8-43c51532831d",
  "bootstrapTokenId": "141bfa06-481e-4684-96eb-cec4ad529616",
  "data": {
    "kycSession": {
      "updatedAt": "2024-01-15T10:35:00.000Z"
    },
    "user": {
      "id": "b9fe022b-f436-49e1-bb89-6f2e8eabf336"
    }
  }
}

user:kyc:identity:failed

Triggered when a user's KYC process has failed.

Schema

• kycSession: KYC session object.
  • updatedAt: Timestamp at which the KYC session was last updated.
• user: User object.
  • id: UUID of the user.

Example

{
  "name": "user:kyc:identity:failed",
  "id": "00a991cf-a870-43af-88b8-43c51532831d",
  "bootstrapTokenId": "141bfa06-481e-4684-96eb-cec4ad529616",
  "data": {
    "kycSession": {
      "updatedAt": "2024-01-15T10:35:00.000Z"
    },
    "user": {
      "id": "b9fe022b-f436-49e1-bb89-6f2e8eabf336"
    }
  }
}