Getting notified about the result

Data provided

Once the user submits all neccessary information a webhook is sent and individual's status changes to onboarding_data_provided.

Example IndividualOnboardingDataProvided event webhook payload:

{
  "id": "d08fb891-40be-4579-90c4-92c648b973f0",
  "name": "IndividualOnboardingDataProvided",
  "created_at": "2021-02-08T14:09:15.000Z"
}

Use the id from the webhook to get more details about the event.

Example IndividualOnboardingDataProvided event payload:

GET /v3/events/d08fb891-40be-4579-90c4-92c648b973f0

Content-Type: application/json
Authorization: Bearer <access_token>

Response:

HTTP 200 OK

{
  "id": "d08fb891-40be-4579-90c4-92c648b973f0",
  "name": "IndividualOnboardingDataProvided",
  "payload": {
  	"individual_id": "bd4af0ff-0a72-4e09-b247-c6d8c2391496"
  },
  "created_at": "2021-02-08T14:09:15.000Z"
}

WARNING

There may be cases when the user drops off without completing the form or doing something similar. For this reason it is recommended that you periodically check individuals who have stuck in onboarding_requested status, and send them to the onboarding form by calling POST /individuals/:id/onboard once again.

Onboarding complete

Eventually, depending on the outcome, you'll receive another webhook event saying the individual was successfully onboarded (IndividualActivated event) or rejected (IndividualBlocked event).

Example IndividualActivated event webhook payload:

{
  "id": "859edbaa-e110-482d-9054-1d187179aaee",
  "name": "IndividualActivated",
  "created_at": "2021-02-08T14:09:15.000Z"
}

Use the id from the webhook to get more details about the event.

Example IndividualActivated event payload:

GET /v3/events/859edbaa-e110-482d-9054-1d187179aaee

Content-Type: application/json
Authorization: Bearer <access_token>

Response:

HTTP 200 OK

{
  "id": "859edbaa-e110-482d-9054-1d187179aaee",
  "name": "IndividualActivated",
  "payload": {
  	"individual_id": "bd4af0ff-0a72-4e09-b247-c6d8c2391496"
  },
  "created_at": "2021-02-08T14:09:15.000Z"
}