The Document Request endpoint (v3) is planned for deprecation in a future release.
New integrations should use Document Request endpoint (v5).
Initiates a document request by generating a one-time-use URL that redirects the consumer to the Capture App to complete the document capture and upload process. See Document Request Endpoint Version 3 for more information.
The URL of the Document Request endpoint for Production, Certification, and Sandbox is https://service.socure.com/api/3.0/documents/request. In the request header, include the Socure_ID+_Key for the corresponding environment as shown below:
| Environment | Endpoint URL | Authorization Header |
|---|---|---|
| Production | https://service.socure.com/api/3.0/documents/request | SocureApiKey YOUR_API_PRODUCTION_KEY |
| Certification | https://service.socure.com/api/3.0/documents/request | SocureApiKey YOUR_API_CERTIFICATION_KEY |
| Sandbox | https://service.socure.com/api/3.0/documents/request | SocureApiKey YOUR_API_SANDBOX_KEY |
Note: You can use the
verificationLevelfield in this endpoint to have the Capture App call ID+ with the Predictive Document Verification and PhoneRisk Score modules after the document capture and upload process is complete. The ID+ results are then returned as a new event using webhooks.
| Time | Status | User Agent | |
|---|---|---|---|
Retrieving recent requests… | |||