Skip to main content

Upload legal representative liveness video

POST 
/v2/users/onboardings/:id/legal-representatives/:legal_representative_id/liveness/video

Submit the representative's recorded video, the provider that verified liveness, its verification identifier and the capture time.Sending a video for any representative selects video verification for all representatives instead of link capture. Before finalizing the onboarding, submit a video and an identity document image in JPEG or PNG up to 5 MiB for every active representative.The result is asynchronous; follow each representative through the liveness links endpoint. After finalization, only a replacement of a video that failed to be processed is accepted while the onboarding and liveness step still allow it. Resending identical bytes after a technical failure can return the existing video with its original timestamps and recovery deadline. A closed or discarded onboarding does not accept uploads.

Request​

Path Parameters

    id stringrequired

    Legal person onboarding ID.

    legal_representative_id stringrequired

    Legal representative 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.

Body

required
    video binaryrequired

    Liveness video file. Formats: video/mp4, video/quicktime. Max size: 50 MB by default.

    liveness_provider stringrequired

    Possible values: <= 255 characters

    Provider that performed the liveness verification the video comes from.

    liveness_provider_transaction_id stringrequired

    Possible values: <= 255 characters

    Identifier of that liveness verification at the provider, kept as an audit reference.

    captured_at date-timerequired

    Possible values: Value must match regular expression ^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}\.\d{3}(?:Z|[+-]\d{2}:\d{2})$

    Instant the video was captured, in YYYY-MM-DDTHH:mm:ss.SSSZ format. It cannot be in the future and the video must be recent: captures older than the accepted window are refused with 422.

Responses​

Video registered, or the existing video returned for a technical retry.

Schema
    id stringrequired

    Liveness video ID.

    onboarding_id stringrequired

    Onboarding ID.

    legal_representative_id string

    Legal representative ID. Present only when the video belongs to a legal representative of a legal person onboarding.

    file_id stringrequired

    Stored video file ID.

    state stringrequired

    Possible values: [UPLOADED, PROCESSING, COMPLETED, FAILED]

    Processing state of the video:

    • UPLOADED: stored, waiting for analysis.
    • PROCESSING: under analysis.
    • COMPLETED: analysis finished.
    • FAILED: analysis could not be completed.

    captured_at date-timerequired

    Capture instant informed on upload.

    created_at date-timerequired

    Upload instant.

Loading...