EnvelopeRecipients: createRecipientProofFileResourceToken

Creates a resource token for a sender. This token allows a sender to return identification data for a recipient using the ID Evidence API.

Request

HTTP request

POST /restapi/v2.1/accounts/{accountId}/envelopes/{envelopeId}/recipients/{recipientId}/identity_proof_token

Parameters

Parameter NameValueDescription
Path Parameters
accountIdstring

The account ID.

envelopeIdstring

The envelope's GUID.

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

recipientIdstring

The recipientIdGuid.

Responses

CodeDescriptionReference
201

Successful response.

proofServiceResourceToken
400

Error encountered.

errorDetails

SDK Method

Envelopes::createRecipientProofFileResourceToken

Definitions

errorDetails

This object describes errors that occur. It is only valid for responses and ignored in requests.

errorCodestring

The code associated with the error condition.

messagestring

A brief message describing the error condition.

proofServiceResourceToken

ResourceTokenstring

Token that can be used to access ID Evidence API endpoints.

}} />