EaserixDocs
DevelopersAPI referenceSignDocuments

A recipient's Government ID result, read from Easerix (owner only)

Returns the result of a recipient's Government ID verification as Persona last reported it. The result is stored in Easerix when Persona's webhook delivers it (or when a reconciliation read settles an inquiry no webhook did), so this call is served from the database and never calls Persona. It is never cached by clients (Cache-Control no-store) and is limited to the fields below: the verified name, per-verification document type, issuing country and check results, and the names of the images that exist. It carries no images (those are fetched one at a time from the photos endpoint) and the document number, birth date and address are never stored or returned. Until Persona has reported anything the status is not_started or in_progress and the other fields are empty. updatedAt is when the stored result last changed. Restricted to the document's owner, because org sharing widens who can read a document and must not widen who can read a signer's identity result. Views are not written to the document's audit trail. A recipient with no Government ID inquiry has no report (404).

View as Markdown
GET
/v1/documents/{id}/recipients/{rid}/verification-report
AuthorizationBearer <token>

In: header

Path Parameters

id*string
rid*string

Response Body

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/v1/documents/string/recipients/string/verification-report"
{  "provider": "persona",  "inquiryId": "string",  "status": "not_started",  "name": "string",  "completedAt": "2019-08-24T14:15:22Z",  "updatedAt": "2019-08-24T14:15:22Z",  "verifications": [    {      "id": "string",      "photos": [        "front"      ],      "kind": "string",      "status": "string",      "documentType": "string",      "country": "string",      "checks": [        {          "name": "string",          "status": "string"        }      ]    }  ]}