Get Recipient Password

A recipient created with requireAccessPassword: true (see Create Session) has to type a password before they can open the documents - a manual second factor on top of the emailed link. AirSign creates the password when the session is sent. The signing email only tells the recipient that a password is needed - the password itself is never emailed.

Use this endpoint to read the password, then give it to the recipient some other way: phone call, text message or in person. Every read is recorded in the session's audit log. The send responses list the recipients that need one under passwordRecipients.

Endpoint

GET https://api.airsign.com.au/api/v1/Session/{sessionId}/Recipient/{recipientId}/AccessPassword

Headers

Example Request

curl --location 'https://api.airsign.com.au/api/v1/Session/{uuid}/Recipient/{uuid}/AccessPassword' \
--header 'Authorization: Bearer {access_token}'

Response

Status: 200 OK

{
    "sessionId": "{uuid}",
    "recipientId": "{uuid}",
    "name": "Ada Lovelace",
    "email": "{valid_email}",
    "accessPassword": "K7QM-4PXR",
    "note": "Give this password to the recipient by phone, text or in person - never by the same email as the signing link. ..."
}

Capitals, spaces and dashes are ignored when the recipient types it. Five wrong attempts lock the recipient out for 15 minutes. If the recipient reassigns the document to someone else, the new signer gets a new password - read it again with this endpoint.

Error Responses