Envelope Recipients

Create the link to the page for manually reviewing IDs

POST
/v2.1/accounts/{accountId}/envelopes/{envelopeId}/recipients/{recipientId}/views/identity_manual_review

This method returns the URL of the page that allows a sender to manually review the ID of a recipient.

Authorization

OAuth2
AuthorizationBearer <token>

OAuth 2.0 access token obtained via Authorization Code Grant or JWT Grant.

In: header

Path Parameters

accountId*string

A value that identifies your account. This value is automatically generated by Docusign for any account you create. Copy the value from the API Account ID field in the AppsI and Keys page.

envelopeId*string

The envelope's GUID.

Example: 93be49ab-xxxx-xxxx-xxxx-f752070d71ec

recipientId*string

A GUID value that Docusign assigns to identify each recipient in an envelope. This value is globally unique for all recipients, not just those in your account.

The specified recipient must belong to a workflow that allows the manual review of IDs. In addition, the status of the automatic verification for this recipient must return Failed and the value of the vendorFailureStatusCode field must be MANUAL_REVIEW_STARTED as shown in the following extract of a response to the GET ENVELOPE method:

"recipientAuthenticationStatus": {       "identityVerificationResult": {              "status": "Failed",             "eventTimestamp": "2020-09-04T16:59:42.8045667Z",             "vendorFailureStatusCode": "MANUAL_REVIEW_STARTED"        }  }

Response Body

application/json

application/json

curl -X POST "https://example.com/v2.1/accounts/string/envelopes/string/recipients/string/views/identity_manual_review"
{  "url": "string"}