Skip to content

Latest commit

 

History

History
194 lines (145 loc) · 9.54 KB

performNetverify.md

File metadata and controls

194 lines (145 loc) · 9.54 KB
Raw

Jumio

performNetverify Implementation Guide

This is a reference manual and configuration guide for the ID Verification API product. It illustrates how to implement the ID Verification API.

Revision history

Information about changes to features and improvements documented in each release is available in our Revision history.

Table of Contents

Using performNetverify

performNetverify offers a Restful ID verification API without Jumio-hosted user interface. Simply send an HTTP POST including the customer's ID image to the URL below. You will immediately receive a JSON response with a Jumio scan reference and a timestamp. A callback will be sent after the verification is complete (see Callback).

⚠️ NOTE: Passports (MRZ) have the highest success rate among ID types. It is recommended for best conversion rates and better data extraction to suggest that your users upload passports when using this submission channel.

HTTP Request Method: POST
REST URL (US): https://netverify.com/api/netverify/v2/performNetverify
REST URL (EU): https://lon.netverify.com/api/netverify/v2/performNetverify
REST URL (SGP): https://core-sgp.jumio.com/api/netverify/v2/performNetverify

Authentication and encryption

ID 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.

⚠️ Never share your API token, API secret, or Basic Auth credentials with anyone — not even Jumio Support.

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.


Request headers

The following fields are required in the header section of your request:

Accept: application/json
Content-Type: application/json
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.

Request body

ℹ️ Values set in your API request will override the corresponding settings configured in the Customer Portal.

Required fields appear in bold type.

Parameter Type Max. length Description
merchantIdScanReference * String 100 Your reference for each scan must not contain sensitive data like PII (Personally Identifiable Information) or account login
frontsideImage * String Max. 15MB & <8000 pixels per side & longest side >300 pixels Base64 encoded image of ID front side
faceImage * String Max. 15MB & <8000 pixels per side & longest side >300 pixels Base64 encoded image of face
*Mandatory if Face match enabled
country * String 3 Possible countries:
• ISO 3166-1 alpha-3 country code
• XKX (Kosovo)
idType * String 255 PASSPORT, DRIVING_LICENSE, ID_CARD, VISA
frontsideImageMimeType String Mime type of front side image
Possible values: image/jpeg (default), image/png
faceImageMimeType String Mime type of face image
Possible values: image/jpeg (default), image/png
backsideImage String Max. 15MB & <8000 pixels per side & longest side >300 pixels Base64 encoded image of ID back side
backsideImageMimeType String Mime type of back side image
Possible values: image/jpeg (default), image/png
enabledFields String 100 Defines fields which will be extracted during the ID verification. If a field is not listed in this parameter, it will not be processed for this transaction, regardless of customer portal settings.
Note: Face match and Address extraction will not be processed unless enabled for your account. If you want to enable them, please contact your Customer Success Manager, or reach out to Jumio Support.
See supported documents for address extraction.
Possible values:
"idNumber,idFirstName,idLastName,idDob, idExpiry,idUsState,idPersonalNumber,idFaceMatch,idAddress"
merchantReportingCriteria String 100 Your reporting criteria for each scan
customerId String 100 Identification of the customer must not contain sensitive data like PII (Personally Identificable Information) or account login
*Mandatory if using Jumio Screening
callbackUrl String 255 Callback URL for the confirmation after the verification is completed (for constraints see Callback URL)
firstName String 100 First name of the customer
lastName String 100 Last name of the customer
usState String 100 Possible values if idType = PASSPORT or ID_CARD:
• Last two characters of ISO 3166-2: US state code
• ISO 3166-1 country name
• Kosovo
• ISO 3166-1 alpha-2 country code
• XK (Kosovo)
• ISO 3166-1 alpha-3 country code
• XKX (Kosovo)

If idType = DRIVING_LICENSE:
• Last two characters of ISO 3166-2: US state code
expiry String Date of expiry in the format YYYY-MM-DD
number String 100 Identification number of the document
dob String Date of birth in the format YYYY-MM-DD
callbackGranularity String 255 Possible values:
• onFinish (default): Callback is only sent after the whole verification
• onAllSteps: Additional callback is sent when the images are received
personalNumber String 14 Personal number of the document

Supported documents for address extraction

Country ID card Driving license Passport Callback format
Australia No Yes No RAW
Bahrain No Yes No RAW
Canada No Yes No RAW
France Yes Yes Yes RAW
Germany Yes No No RAW
Indonesia Yes No No RAW
Ireland No Yes No RAW
Malaysia Yes No No RAW
Malta Yes Yes No RAW
Mexico Yes No No RAW
Peru Yes Yes No RAW
Romania Yes No No RAW
Singapore Yes No No RAW
Spain Yes No No RAW
United Kingdom No Yes No RAW
United States Yes Yes No RAW

Response

Parameter Type Max Length Description
timestamp String Timestamp (UTC) of the response
format: YYYY-MM-DDThh:mm:ss.SSSZ
jumioIdScanReference String 36 Jumio's reference number for each scan

Examples

Sample request

POST https://netverify.com/api/netverify/v2/performNetverify HTTP/1.1
Accept: application/json
Content-Type: application/json
Content-Length: 1234
User-Agent: Example Corp SampleApp/1.0.1
Authorization: Basic xxxxxxxxxxxxxxxxxxxxxxxxxxxxx

{
  "merchantIdScanReference": "YOURSCANREFERENCE",
  "frontsideImage": "YOURBASE64STRING",
  "country": "XKX",
  "idType": "PASSPORT"
}
⚠️ Sample requests cannot be run as-is. Replace example data with your own parameter values.

Sample Response

{
  "timestamp": "2017-08-16T10:37:44.623Z",
  "jumioIdScanReference": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
}

Configuring settings in the Customer Portal

In the Settings screen of the Customer Portal you can customize your settings and brand your ID Verification page.
Save changes using your Customer Portal password to activate them.

ℹ️ Values set in your API request will override the corresponding settings configured in the Customer Portal.

Application settings — General

Callback URL

Define a Callback URL to receive verification results and extracted user data from Jumio when a transaction is completed. For more information, see our Callback documentation.

URL requirements:

URL restrictions:

  • IP addresses, ports, query parameters and fragment identifiers are not allowed.
  • Personally identifiable information (PII) is not allowed in any form.

© Jumio Corporation, 395 Page Mill Road, Suite 150 Palo Alto, CA 94306