Get IDV Session Result

This endpoint will return the result of the Identity verification session in JSON format.

Hint If a recipient successfully signed the document but was unable to complete a session due to a technical problem (like a problem with their camera), the session status will be ONGOING.

Important If the recipient needs to attempt IDV again the sender must resend the envelope.

GET https://api.yotisign.com/v2/idv/recipients/:recipientID/sessions/signed/json

Headers Explained

The following elements are needed:

Response

On success, we return a 200 with a JSON body matching the following schema:

{

  "session_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

  "client_session_token_ttl": 599,

  "user_tracking_id": "string",

  "biometric_consent": "2022-12-01T15:23:28.894Z",

  "state": "ONGOING",

  "client_session_token": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

  "resources": {...},

  "checks": [...]

}

Error codes

If the request is unsuccessful we will respond with an appropriate HTTP code, and a message will be detailed in the response body.