Skip to content

Recipients

Get a recipient

Retrieve a recipient by its ID to read its type, status, ceremony details and completion time while the envelope moves through signing.

GET
/ v1 / recipients / {recipient_id}

Retrieves the details of a recipient, including their current status, ceremony information, and completion timestamp.

Use this endpoint to check a recipient’s progress through the signing workflow. The response includes the full recipient object for the recipient’s type: signer, approver, preparer, automatic signer, or qualified signer. The type property tells you which one.

Path Parameters

recipient_idstringrequired

The unique identifier of the recipient. Recipient IDs use the re_ prefix.

Returns

Returns a 200 OK status code along with a recipient object if successful, or an error otherwise.