Skip to main content

Get onboarding liveness link

GET 
/v2/users/onboardings/:id/liveness

Returns the progress and capture method of the liveness step. Use the capture link when method is LINK. Submitting a liveness video selects VIDEO_UPLOAD and no capture link is returned; submit the video before completing the onboarding documents. Consult the onboarding endpoint for the overall result and the video upload endpoint for replacement requirements.

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, REJECTED]

    Liveness progress of this onboarding:

    • PENDING: video received and awaiting analysis, or link not available yet.
    • WAITING_SUBMISSION: complete the capture through the link, or submit or replace the video while the onboarding is open.
    • IN_ANALYSIS: await the result without resending.
    • APPROVED: liveness approved.
    • REJECTED: liveness rejected; do not resend.
    This status describes the liveness step. Consult the onboarding endpoint for the overall result. WAITING_SUBMISSION does not permit a new upload after the onboarding is closed or discarded.

    submitted_at date-time

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

    method stringrequired

    Possible values: [LINK, VIDEO_UPLOAD]

    How the liveness is being verified:

    • LINK: guided capture through the liveness link.
    • VIDEO_UPLOAD: liveness video uploaded through the video endpoint; no link is issued.

Loading...