Skip to main content

Get onboarding liveness link

GET 
/v1/users/onboardings/:id/liveness

Returns the liveness link already created for the onboarding, if any. Absent url means the link has not been created yet.

Request​

Path Parameters

    id stringrequired

    Natural person onboarding ID.

Header Parameters

    nonce stringrequired

    The nonce ID is a UUID (v4) used to uniquely identify the request. All requests must have an identifier.

    x-product-uuid string

    UUID (v4) of the product that the request should use. Send it explicitly when the authenticated user has more than one product or when the integration must select a specific product. If omitted and the endpoint does not require it, the API uses the authenticated user's default product.

    x-product-target-user-uuid string

    UUID (v4) of the user on whose behalf the request should run within the selected product. If omitted, the request runs as the authenticated user. Requires x-product-uuid.

    x-lang string

    Possible values: [pt-BR, en-US]

    Indicates the preferred language. Defaults to Brazilian Portuguese if unspecified.

Responses​

Liveness link retrieved.

Schema
    url string

    Liveness link. Absent while the link has not been created yet.

    status stringrequired

    Possible values: [PENDING, WAITING_SUBMISSION, IN_ANALYSIS, APPROVED]

    Liveness progress of this onboarding:

    • PENDING: link not created yet.
    • WAITING_SUBMISSION: link issued, the user has not done the liveness.
    • IN_ANALYSIS: submitted, under analysis.
    • APPROVED: done.

    submitted_at date-time

    When the liveness was submitted. Absent while nothing was submitted.

Loading...