Get an onboarding

get/onboardings/{id}

Preview

External ID

Get the current state of an onboarding by its id or onboarding_external_id. Often used to check on an onboarding created by POST /onboardings. It is safe to poll a pending onboarding until it reaches a decision.

When the user still has steps left to complete, the response carries a continue_onboarding token and link for the user to complete the flow.

For more information, see here.

Request

Path parameters

id·

string

Response

continue_onboarding·

optional object

expires_at·

string

link·

string

A Footprint link embedding the token that can be sent to this user to allow them to complete the flow. This is useful to send in an automated message to the end user.

token·

string

A short-lived onboarding session token for the user to continue their onboarding flow. NOTE: treat this token as a secret.

error_message·

optional string

If the onboarding failed, the error message from the execution.

id·

string

output·

optional object

The output declared by your playbook's Output node, keyed by the names you configured there. Absent when your playbook declares no output or when the onboarding hasn't yet reached the Output node. Fetch the onboarding again once it completes to read it.

requires_manual_review·

boolean

status·

string

The decision for this onboarding issued by the Action nodes on your playbook. For more information on interpreting statuses, see here.

Allowed values:

pass

fail

incomplete

pending

none

error

GET /onboardings/{id}

1curl https://api.onefootprint.com/onboardings/{id} \
2  -u sk_test_xxxxx:

Response example

{
  "continue_onboarding": {
    "expires_at": "2022-01-04T12:00-07:00",
    "link": "https://verify.onefootprint.com/?type=user#obtok_ssPvNRjNGdk8Iq9qgf6lsO2iTVhALuR4Nt",
    "token": "obtok_UxM6Vbvk2Rcy1gzcSuXgk3sj3L9I0pAnNH"
  },
  "id": "id_nDtKC0iGmi3klqpHJd5KoS",
  "requires_manual_review": true,
  "status": "pass"
}