This is a reference manual and configuration guide for the Fastfill API. It illustrates how to immediately retrieve information from an ID image.
Information about changes to features and improvements documented in each release is available in our Revision history.
All Document Verification API calls are protected using HTTP Basic Authentication. Your Basic Auth credentials are constructed using your API token as the user-id and your API secret as the password. You can view and manage your API token and secret in the Customer Portal under Settings > API credentials.
The TLS Protocol is required to securely transmit your data, and we strongly recommend using the latest version. For information on cipher suites supported by Jumio during the TLS handshake see supported cipher suites.
Call the RESTful HTTP POST API fastfill from your server with the below parameters to create a transaction for each user. Simply submit front and/or back side image(s) of the user's document with a maximum file size of 5 MB and you will immediately receive the ID information as a JSON response.
Note: Requests originating from the client are not supported (CORS is disabled) and the API credentials must never be exposed on the client side.
HTTP request method: POST
REST URL (US): https://netverify.com/api/netverify/v2/fastfill
REST URL (EU): https://lon.netverify.com/api/netverify/v2/fastfill
REST URL (SGP): https://core-sgp.jumio.com/api/netverify/v2/fastfill
The following fields are required in the header section of your request:
Accept: application/json
Content-Type: multipart/form-data
Content-Length: (see RFC-7230)
Authorization: (see RFC 7617)
User-Agent: YourCompany YourApp/v1.0
ℹ️ Jumio requires the User-Agent value to reflect your business or entity name for API troubleshooting. |
|---|
Note: Calls with missing or suspicious headers, suspicious parameter values, or without HTTP Basic Authentication will result in HTTP status code, 403 Forbidden.
| Key | Value |
|---|---|
| frontsideImage | JPEG, PNG file with max size of 5 MB Front side image of the customer's document Mandatory - if type = PASSPORT - If type = ID_CARD or DRIVING_LICENSE and backsideImage not provided |
| backsideImage | JPEG, PNG file with max size of 5 MB Back side image of the customer's document if type = ID_CARD or DRIVING_LICENSE Mandatory if frontsideImage not provided |
| metadata | Details of the user's document specified as a JSON object |
The metadata object in the body of your single-page complete API request allows you to
- specify what type of document is being submitted
- set the country of the uploaded document type.
Required items appear in bold type.
| Name | Type | Max. length | Description |
|---|---|---|---|
| type | string | Possible types: - PASSPORT - ID_CARD - DRIVING_LICENSE |
|
| country | string | 3 | Possible values: • ISO 3166-1 alpha-3 country code • XKX (Kosovo) |
Note: Mandatory parameters are marked with an asterisk * and highlighted bold.
| Parameter | Type | Max. Length | Description |
|---|---|---|---|
| scanReference * | String | Jumio’s reference number for each scan | |
| type | String | Possible types: - PASSPORT - ID_CARD - DRIVING_LICENSE |
|
| issueDate | String | 255 | Issue date in the format YYYY-MM-DD |
| issuingCountry | String | 3 | Possible countries: - ISO 3166-1 alpha-3 country code - XKX (Kosovo) |
| originatingCountry | Possible countries: - ISO 3166-1 alpha-3 country code - XKX (Kosovo) |
||
| number | String | 255 | Identification number of the document |
| firstName | String | 255 | First name of the customer |
| lastName | String | 255 | Last name of the customer |
| dob | String | 255 | Date of birth in the format YYYY-MM-DD |
| expiry | String | 255 | Date of expiry in the format YYYY-MM-DD |
| optionalData1 | String | 255 | Optional field of MRZ (TD1) line 1 |
| optionalData2 | String | 255 | Optional field of MRZ (TD1 and TD2) line 2 |
| personalNumber | String | 255 | Personal number field of MRZ (MRP) |
| street | String | 255 | Street if type = DRIVING_LICENSE |
| city | String | 255 | City if type = DRIVING_LICENSE |
| state | String | 255 | State if type = DRIVING_LICENSE |
| postalCode | String | 255 | Postal code if type = DRIVING_LICENSE |
| gender | String | 255 | Possible values: - M - F |
Optional parameters are returned:
- If available on the ID
- If readable
- As readable (can be invalid)
POST https://netverify.com/api/netverify/v2/fastfill HTTP/1.1
Accept: application/json
Content-Type: multipart/form-data;boundary=----xxxx
Content-Length: xxx
User-Agent: YOURCOMPANYNAME YOURAPPLICATIONNAME/x.x.x
Authorization: Basic
----xxxx
Content-Disposition: form-data; name="metadata"
Content-Type: application/json
{
"type": "PASSPORT",
"country": "USA"
}
----xxxx
Content-Disposition: form-data; name="frontsideImage"
Content-Type: image/jpeg
// Your image
----xxxx
{
"dob": "1990-01-01",
"expiry": "2022-12-31",
"firstName": "FIRSTNAME",
"issueDate": "2012-12-31",
"issuingCountry": "USA",
"lastName": "LASTNAME",
"number": "P1234",
"originatingCountry": "USA",
"personalNumber": "12345",
"scanReference": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
"type": "PASSPORT"
}
The Fastfill API supports:
-
All ID Verification supported passports
-
ID cards from the following countries: Albania, Argentina, Austria, Belgium, Bosnia & Herzegovina, Bulgaria, Canada, Cameroon, Chile, Czech Republic, Denmark, Dominican Republic, Ecuador, El Salvador, Estonia, Finland, France, Georgia, Germany, Guatemala, Hungary, Italy, Kazakhstan, Kenya, Latvia, Liechtenstein, Macedonia, Malta, Mexico, Moldova, Montenegro, Netherlands, Pakistan, Paraguay, Peru, Poland, Portugal, Romania, Serbia, Slovakia, Slovenia, Spain, Sweden, Switzerland, Turkey, United Arab Emirates, United Kingdom.
-
Driver licenses from the following countries: Austria, Belgium, Canada, Czech Republic, Denmark, Finland, France, Germany, Ireland, Italy, Netherlands, Poland, Portugal, Romania, Slovakia, Spain, Sweden, United Kingdom, United States.
PDF417 bar code extraction from driver licenses back side from USA and Canada.
Jumio supported cipher suites during the TLS handshake.
© Jumio Corporation, 395 Page Mill Road, Suite 150 Palo Alto, CA 94306