ID Evidence API 101

The ID Evidence API enables Docusign customers using ID Verification (IDV) to retrieve the data that can be stored while verifying a signer’s ID. By default, no personal data is stored with IDV. The only data that is stored is the status of the ID verification, transaction number, and the name of the third-party ID verifier. A recipient (signer) is considered to be authenticated if the government-issued ID is validated, but you must configure which data fields Docusign is authorized to store as ID evidence, if you want to retrieve personal data afterwards (see Enabling ID Evidence storage).

Two categories of API calls can be made with the ID Evidence API:

• Events: Log of all state changes to an envelope’s recipient during the ID verification process; stores the selected text-based data, such as name, date of birth, and more.
• Media: Retrieval of configured ID verification image data that was captured for a corresponding event. For example, media is stored for an event that is generated as a result of a recipient’s passport verification.

Note: When working with the ID Evidence API, you’ll notice the name of some endpoints referring to proof. This is because data stored as part of the IDV process is proof that the ID was verified.

Every time a sender posts an envelope that requires ID Verification, Docusign calls the ID Evidence API to initiate a new proof file for each recipient, which is used to store data. Once the transaction is initiated, an Envelope Sent event is triggered and pushed to the ID Evidence API, along with its media (data). When an envelope recipient uploads their ID, ID Verification pushes a new Upload Image event to the envelope’s proof file. ID Verification continues to log events with every transactional state change.

For more information about ID Evidence, see the ID Evidence Q&A.