Document Request endpoint version 3

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:

EnvironmentEndpoint URLAuthorization Header
Productionhttps://service.socure.com/api/3.0/documents/requestSocureApiKey YOUR_API_PRODUCTION_KEY
Certificationhttps://service.socure.com/api/3.0/documents/requestSocureApiKey YOUR_API_CERTIFICATION_KEY
Sandboxhttps://service.socure.com/api/3.0/documents/requestSocureApiKey YOUR_API_SANDBOX_KEY

Note: You can use the verificationLevel field 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.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
integer
enum
required

The verification process workflow for the transaction. Below are the possible values.

  • 1: Document upload only
  • 2: Document upload and verification
  • 3: Document upload, verification, and Phone Risk.
Allowed:
config
object

The configurations for the document request transaction.

string
length ≤ 100

A client-specified unique identifier for the transaction.

string
length ≤ 240

The consumer’s first name.

Note:

  • UTF-8 single byte latin characters are supported.
  • The following special characters are not supported: ^±!@£$%&*_+¡€#¢§¶•ªº«<>?\/:;|=
  • The field accepts backslashes to prevent HTTP 400 errors; these are removed during preprocessing to guard against injection attacks and ensure consistent data storage, resulting in an HTTP 200 response. If a backslash is the only input, it returns an empty string.
string
length ≤ 240

The consumer’s last name.

Note:

  • UTF-8 single byte latin characters are supported.
  • The following special characters are not supported: ^±!@£$%&*_+¡€#¢§¶•ªº«<>?\/:;|=
  • The field accepts backslashes to prevent HTTP 400 errors; these are removed during preprocessing to guard against injection attacks and ensure consistent data storage, resulting in an HTTP 200 response. If a backslash is the only input, it returns an empty string.
string

The consumer's date of birth, preferably in YYYY-MM-DD, YYYYMMDD, or YYYY/MM/DD format.

string

The consumer’s phone number in E.164 format, which includes the country code (e.g., + followed by international dialing code and number).
Hyphens are optional. A mobile phone number is preferred.

Example formats:

  • United States: +13475550100
  • United Kingdom: +447911123456
  • Brazil: +5511987654321
  • India: +919876543210
  • Australia: +61412345678

Note: mobileNumber is required for verificationLevel 3.

string

The first line of the consumer's address.

string

An optional second line for the address.

string

The consumer's city of residence in valid postal address format.

Note: city is required for international requests.

string
length between 2 and 2

The state, province, or region where the consumer resides, specified in ISO 3166-2 format.

Note:

  • If the physical address is within a U.S. territory, you can pass the territory name in either the state or country field.
  • If the physical address is in a country or state that does not require state, do not include this field in the API call.
string

The consumer's five or nine-digit ZIP code must be in a valid postal address format. Hyphens or spaces are optional.

Note:

  • If the physical address is in a country or state that does not require zip, do not include this field in the API call.
  • This field accepts a 9-digit zip code, with spaces allowed in place of hyphens (e.g., 94502 1397 instead of 94502-1397).
string

The country where the consumer resides, specified in ISO 3166-1 alpha-2 format.

Note: country is required for international requests.

Responses

Language
Credentials
Header
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json