Get IDV Session Result
This endpoint will return the result of the Identity verification session in JSON format.
HintIf 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:
Header | Description |
|---|---|
Authorization | API Key to call the Yoti Sign API. This should be sent as a bearer token. |
Response
On success, we return a 200 with a JSON body matching the following schema:
›
›
{
…
}
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.
Last updated on
Was this page helpful?
Next to read:
Get IDV Session PDFGot a question? Contact us here.
Welcome
eSignatures API