Status of sign request

Checking the status of a Sign Request is achieved through the GET sign request endpoint.

Status of sign request endpoint

Below is the end point used for get sign request.

HTTP
Copy

Example

A complete example of how to GET the status of a sign request can be found below.

Javascript
Copy
ParameterDescription
Authorization (header)Your API Key is required on all calls to the API and should be sent as a bearer token.
Content-Type (header)application/json

sign_request_id

(path)

This is a UUID referring to the Sign Request you are looking to retrieve. This will be the UUID obtained from the Create Sign Request endpoint

Example of response

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

JSON
Copy
ResponseDescription
idThe sign request ID, this identifies the sign request.
completed_atOnce all signees have signed the document it is marked as COMPLETE, the completed_at field stores the timestamp of when the last signee completes the request.
statusThe status of a sign request can either be "COMPLETE", "ACTIVE" or "ARCHIVED. A sign request defaults to "ACTIVE" and will remain in this state until all signees have signed the document. Once it is fully signed the state will update to "COMPLETE". A status may be "ARCHIVED" if you archive a document using the archive sign request endpoint.
file_nameThe name of the document as specified in the create sign request body.
completed_file_locationThis is the location of the completed document, this URL may be used with valid authentication to retrieve the completed document at a later date.
recipientsAn array containing the list of signees and a breakdown of their status in regards to the sign request.
Response (Recipients)Description
idUsed to identify who has signed this document.
sign_statusThe sign_status may be one of either "SIGNED" or "UNSIGNED"
roleThe role is returned as specified when creating the sign request.
signed_atA timestamp indicating when the signee signed the document.
nameThe name of the signee
emailThe email address of the signee.
yoti_attributesIf the sign request was sent to a signee requesting yoti_attributes, the list of signed attributes are returned, this an array of any of the following values [postal address, selfie, full_name, date_of_birth, gender, nationality, phone_number].

Other response codes

ResponseDescription
401401 is returned if a request is unauthorised. This is likely due to the API Key either being incorrect or not being sent properly in the headers. The key should be sent as a Bearer token over the authorisation header.
404If the request is not found you will receive a 404. This will be due to the request ID being invalid.
Type to search, ESC to discard
Type to search, ESC to discard
Type to search, ESC to discard