The callback is the authoritative answer from Jumio. Specify a callback URL (for constraints see Configuring Settings in the Customer Portal) to recieve the ID verification result for each scan.
Information about changes to features and improvements documented in each release is available in our Revision history.
- Jumio Callback IP List
- Callback for Netverify
- Callback for Document Verification
- Netverify Retrieval API
Whitelist these IP addresses for callbacks, and use them to verify that the callback originated from Jumio.
US data center:
34.202.241.227
34.226.103.119
34.226.254.127
52.52.51.178
52.53.95.123
54.67.101.173
104.130.61.196
146.20.77.156
184.106.91.66
184.106.91.67
Use the hostname callback.jumio.com to look up the most current IP addresses.
EU data center:
34.253.41.236
35.157.27.193
52.48.0.25
52.57.194.92
52.58.113.86
52.209.180.134
162.13.228.132
162.13.228.134
162.13.229.103
162.13.229.104
Use the hostname callback.lon.jumio.com to look up the most current IP addresses.
An HTTP POST request is sent to your specified callback URL (see Configuring Settings in the Customer Portal) containing an application/x-www-form-urlencoded formatted string with the result.
For mobile: ID verification must be enabled to receive the callback.
| User journey state | Scan state | Callback |
|---|---|---|
| Not started | Pending => Failed | Transaction will be cleaned-up from pending to failed after the authorization token lifetime expires Callback: Verification status NO_ID_UPLOADED |
| Drop off during first attept | Pending => Failed | Transaction will be finished 15 minutes after the last update Callback: Verification status NO_ID_UPLOADED |
| Drop off during second or third attempt | Done | Transaction will be finished 15 minutes after the last update Callback: Verification status ERROR_NOT_READABLE_ID with previous reject reason |
| Finished | Done | Callback: Verification status depends on the result |
| User journey state | Scan state | Callback |
|---|---|---|
| Drop off | Pending => Failed | Transaction will be cleaned-up from pending to failed 15 minutes after last update Callback: verification status NO_ID_UPLOADED |
| Finished | Done | ID verification will be performed Callback: verification status depends on the result (see table below) |
The following parameters are posted to your callback URL for Netverify Web embedded, redirect, performNetverify and Netverify Mobile iOS/Android.
Required items appear in bold type.
| Parameter | Max. Length | Description | Notes |
|---|---|---|---|
| callBackType | NETVERIFYID | ||
| jumioIdScanReference | 36 | Jumio’s reference number for each scan | |
| verificationStatus | Possible states: • APPROVED_VERIFIED • DENIED_FRAUD • DENIED_UNSUPPORTED_ID_TYPE1 • DENIED_UNSUPPORTED_ID_COUNTRY1 • ERROR_NOT_READABLE_ID • NO_ID_UPLOADED |
||
| idScanStatus | SUCCESS if verificationStatus = APPROVED_VERIFIED, otherwise ERROR | ||
| idScanSource | Possible values: • WEB (if Netverify Web embedded and no camera or upload started) • WEB_CAM (if Netverify Web embedded via camera) • WEB_UPLOAD (if Netverify Web embedded via upload) • REDIRECT (if Netverify Web redirect and no camera or upload started) • REDIRECT_CAM (if Netverify Web redirect via camera) • REDIRECT_UPLOAD (if Netverify Web redirect via upload) • API (if performNetverify) • SDK (if mobile) |
||
| idCheckDataPositions | "OK" if verificationStatus = APPROVED_VERIFIED, otherwise "N/A" | ||
| idCheckDocumentValidation | "OK" if verificationStatus = APPROVED_VERIFIED, otherwise "N/A" | ||
| idCheckHologram | "OK" if verificationStatus = APPROVED_VERIFIED, otherwise "N/A" | ||
| idCheckMRZcode | "OK" for passports and supported ID cards if verificationStatus = APPROVED_VERIFIED and MRZ check is enabled, otherwise "N/A" | not returned for NLD, DEU, KOR if NV masking is enabled 4 | |
| idCheckMicroprint | "OK" if verificationStatus = APPROVED_VERIFIED, otherwise "N/A" | ||
| idCheckSecurityFeatures | "OK" if verificationStatus = APPROVED_VERIFIED, otherwise "N/A" | ||
| idCheckSignature | "OK" if verificationStatus = APPROVED_VERIFIED, otherwise "N/A" | ||
| transactionDate | Timestamp (UTC) of the scan creation format: YYYY-MM-DDThh:mm:ss.SSSZ |
||
| callbackDate | Timestamp (UTC) of the callback creation format: YYYY-MM-DDThh:mm:ss.SSSZ |
||
| identityVerification | Identity verification as JSON object, ONLY if verificationStatus = APPROVED_VERIFIED see table Identity Verification below |
activation required | |
| idType | Possible types: • PASSPORT • DRIVING_LICENSE • ID_CARD • VISA Currently, Jumio only supports US and China visas in certain cases. However, visas from other countries will be rejected as unsupported with idType = VISA |
||
| idSubtype | 255 | Possible subtypes if idType = ID_CARD • NATIONAL_ID • CONSULAR_ID • ELECTORAL_ID • RESIDENT_PERMIT_ID • TAX_ID • STUDENT_ID • PASSPORT_CARD_ID • MILITARY_ID • PUBLIC_SAFETY_ID • OTHER_ID • VISA • UNKNOWN Possible subtypes if idType = DRIVING_LICENSE • LEARNING_DRIVING_LICENSE Possible subtypes if idType = PASSPORT • E_PASSPORT (only for mobile) |
|
| idCountry | 3 | Possible countries: • ISO 3166-1 alpha-3 country code • XKX (Kosovo) |
|
| rejectReason | Reject reason as JSON object if verificationStatus = DENIED_FRAUD or ERROR_NOT_READABLE_ID, see tables below | ||
| idScanImage | 255 | URL to retrieve the image of the scan (JPEG or PNG) if available2 | |
| idScanImageFace | 255 | URL to retrieve the face image of the scan (JPEG or PNG) if available2 | |
| idScanImageBackside | 255 | URL to retrieve the back side image of the scan (JPEG or PNG) if available2 | |
| idNumber | 200 | Identification number of the document as available on the ID if verificationStatus = APPROVED_VERIFIED and enabled, otherwise if provided | |
| idFirstName | 200 | • First name of the customer as available on the ID if verificationStatus = APPROVED_VERIFIED and enabled, otherwise if provided • For following documents, N/A returned (if name contains non-Latin characters) - if idCountry = CHN and idType = DRIVING_LICENSE or ID_CARD - if idCountry = KOR and idType = DRIVING_LICENSE or ID_CARD - if idCountry = JPN and idType = DRIVING_LICENSE - if idCountry = RUS and idType = ID_CARD |
|
| idLastName | 200 | • Last name of the customer as available on the ID if verificationStatus = APPROVED_VERIFIED and enabled, otherwise if provided • Only if full name is printed in Latin characters - if idCountry = KOR and idType = DRIVING_LICENSE (first name and last name) • For following documents, N/A returned (if name contains non-Latin characters) - if idCountry = CHN and idType = DRIVING_LICENSE or ID_CARD - if idCountry = KOR and idType = DRIVING_LICENSE or ID_CARD - if idCountry = JPN and idType = DRIVING_LICENSE - if idCountry = RUS and idType = ID_CARD |
|
| idDob | 10 | Date of birth in the format YYYY-MM-DD as available on the ID if verificationStatus = APPROVED_VERIFIED and enabled, otherwise if provided If idCountry = IND date of birth can be incomplete, possible values e.g.: • Year-Month-Day: 1990-12-09 • Year only: 1990-01-01 • Year-Month: 1990-12-01 • Year-Day: 1990-01-09 Additional parameter "originDob" will be provided |
not returned for KOR if NV masking is enabled |
| idExpiry | 10 | Date of expiry in the format YYYY-MM-DD as available on the ID if verificationStatus = APPROVED_VERIFIED and enabled, otherwise if provided | |
| idUsState | 255 | Possible values if idType = PASSPORT or ID_CARD: • Last two characters of ISO 3166-2:US state code • Last 2-3 characters of ISO 3166-2:AU state code • Last two characters of ISO 3166-2:CA state code • ISO 3166-1 country name • XKX (Kosovo) • Free text - if it can't be mapped to a state/country code If idType = DRIVING_LICENSE: • Last two characters of ISO 3166-2:US state code • Last 2-3 characters of ISO 3166-2:AU state code • Last two characters of ISO 3166-2:CA state code |
|
| personalNumber | 14 | Personal number of the document • if verificationStatus = APPROVED_VERIFIED and • if idType = PASSPORT and if data available on the document |
not returned for NLD, DEU, KOR if NV masking is enabled 4 |
| idAddress | Address as JSON object in US, EU or raw format if verificationStatus = APPROVED, see tables below3 | activation required | |
| merchantIdScanReference | 100 | Your reference for each scan | |
| merchantReportingCriteria | 100 | Your reporting criteria for each scan | |
| customerId | 100 | ID of the customer as provided | |
| clientIp | IP address of the client in the format xxx.xxx.xxx.xxx | ||
| firstAttemptDate | Timestamp (UTC) of the first scan attempt format: YYYY-MM-DDThh:mm:ss.SSSZ |
||
| optionalData1 | 255 | Optional field of MRZ line 1 | not returned for NLD ID if NV masking is enabled 4 |
| optionalData2 | 255 | Optional field of MRZ line 2 | |
| dni | 255 | DNI as available on the ID if idCountry = ESP and idSubtype = NATIONAL_ID | |
| curp | 255 | CURP as available on the ID if idCountry = MEX and idSubtype = ELECTORAL_ID | activation required |
| gender | 2 | Possible values: M, F • if idCountry = FRA and idSubtype = NATIONAL_ID (MRZ type CNIS) • if idType = VISA and additional extraction for Visa enabled |
|
| presetCountry | 3 | Possible countries: • ISO 3166-1 alpha-3 country code • XKX (Kosovo) |
|
| presetIdType | Possible ID types: PASSPORT, DRIVING_LICENSE, ID_CARD | ||
| dlCarPermission | 255 | Only available if: •Extraction supported for specific country •verificationStatus = APPROVED_VERIFIED Possible values: • YES • NO • NOT_READABLE |
activation required |
| dlCategories | JSON object | Driver license categories as JSON object if verificationStatus = APPROVED_VERIFIED, see table below Supported Countries: • Austria • Belgium • France • Germany • Great Britain • Italy • Netherlands • Spain • Taiwan |
activation required |
| nationality | 3 | Nationality if idType = VISA and additional extraction for Visa enabled. Possible countries: • ISO 3166-1 alpha-3 country code • XKX (Kosovo) |
activation required |
| passportNumber | 255 | Passport number if idType = VISA and additional extraction for Visa enabled | activation required |
| durationOfStay | 255 | Duration of stay if idType = VISA and additional extraction for Visa enabled | activation required |
| numberOfEntries | 255 | Number of entries if idType = VISA and additional extraction for Visa enabled | activation required |
| visaCategory | 255 | Visa category if idType = VISA and additional extraction for Visa enabled | activation required |
| originDob | 10 | Original format of date of birth if idCountry = IND Possible values e.g.: • Year/Month/Day: 1990/12/09 • Year only: 1990// • Year/Month: 1990/12/ • Year/Day: 1990//09 |
|
| issuingAuthority | 50 | Issuing authority of the document (if issuing authority extraction is enabled) | activation required |
| issuingDate | 10 | Issuing date of the document (if issuing date extraction enabled) | activation required |
| issuingPlace | 50 | Issuing place of the document (if issuing place extraction is enabled) | activation required |
| livenessImages | URLs to the liveness images of the transaction (JPEG or PNG) if available5 |
1 Scan is declined as unsupported if the provided ID is not supported by Jumio, or not accepted in your Netverify settings.
2 For ID types that are configured to support a separate scan of the front side and back side, there is a separate image of the front side (idScanImage) and the back side (idScanImageBackside). If face match is enabled, there is also a picture of the face (idScanImageFace).
3 Address recognition is performed for supported IDs, if enabled. Please note, there are three different address formats (US, EU, Raw). Please check Supported documents for Address Extraction to see which format applies to specific IDs. The different address parameters are a part of the JSON object, if they are available on the ID.
4 Fields containing certain kinds of personally identifying information are not returned if NV masking is enabled for the Netherlands, Germany, or South Korea. See Netverify masking for more information.
5 Liveness images are returned only for transactions containing Identity Verification submitted via the Android and iOS SDKs. The number of images can vary from scan to scan and might not be returned in chronological order.
Use HTTP: GET with Basic Authorization using your API token and secret, as userid and password.
Header: The following parameters are mandatory in the "header" section of your request.
Accept: image/jpeg, image/pngUser-Agent: YOURCOMPANYNAME YOURAPPLICATIONNAME/VERSION
The value for User-Agent must contain a reference to your business or entity for Jumio to be able to identify your requests. (e.g. YourCompanyName YourAppName/1.0.0). Without a proper User-Agent header, Jumio will take longer to diagnose API issues.
The TLS protocol is required during the TLS handshake (see Supported cipher suites) and we strongly recommend using the latest version.
| Country | ID card | Driving license | Passport | Callback format |
|---|---|---|---|---|
| Australia | No | Yes | No | US |
| Bahrain | No | Yes | No | Raw |
| Canada | No | Yes | No | US |
| France | Yes | Yes | Yes | Raw |
| Germany | Yes | No | No | EU |
| Indonesia | Yes | No | No | Raw |
| Ireland | No | Yes | No | Raw |
| Mexico | Yes | No | No | US |
| Romania | Yes | No | No | Raw |
| Singapore | Yes | No | No | Raw |
| Spain | Yes | No | No | EU |
| United Kingdom | No | Yes | No | Raw |
| United States | No | Yes | No | US |
| Parameter "idAddress" | Max. Length | Description |
|---|---|---|
| city | 64 | City |
| stateCode | 6 | ISO 3166-2 state code |
| streetName | 64 | Street name |
| streetSuffix | 14 | Street suffix abbreviation Examples: US, Canada, Australia |
| streetDirection | 255 | Street direction abbreviation Examples: US (E=EAST, W=WEST, N=NORTH, S=SOUTH), Canada, Australia |
| streetNumber | 14 | Street number |
| unitDesignator | 14 | Unit designator abbreviation Examples: US, Canada, Australia |
| unitNumber | 14 | Unit number |
| zip | 14 | Zip code |
| zipExtension | 20 | Zip extension |
| country | 3 | Possible countries: • ISO 3166-1 alpha-3 country code • XKX (Kosovo) |
| Parameter "idAddress" | Max. Length | Description |
|---|---|---|
| city | 64 | City |
| province | 64 | Province |
| streetName | 64 | Street name |
| streetNumber | 15 | Street number |
| unitDetails | 64 | Unit details |
| postalCode | 15 | Postal code |
| country | 3 | Possible countries: • ISO 3166-1 alpha-3 country code • XKX (Kosovo) |
| Parameter "idAddress" | Max. Length | Description |
|---|---|---|
| line1 | 100 | Line item 1 |
| line2 | 100 | Line item 2 |
| line3 | 100 | Line item 3 |
| line4 | 100 | Line item 4 |
| line5 | 100 | Line item 5 |
| country | 3 | Possible countries: • ISO 3166-1 alpha-3 country code • XKX (Kosovo) |
| postalCode | 15 | Postal code |
| city | 64 | City |
| Parameter "rejectReason" | Type | Max. Length | Description |
|---|---|---|---|
| rejectReasonCode | String | 5 | see below |
| rejectReasonDescription | String | 64 | Possible codes and descriptions for verification status DENIED_FRAUD: 100 MANIPULATED_DOCUMENT 105 FRAUDSTER 106 FAKE 107 PHOTO_MISMATCH 108 MRZ_CHECK_FAILED 109 PUNCHED_DOCUMENT 110 CHIP_DATA_MANIPULATED (only available for ePassport) 111 MISMATCH_PRINTED_BARCODE_DATA Possible codes and descriptions for verificationStatus = ERROR_NOT_READABLE_ID: 102 PHOTOCOPY_BLACK_WHITE 103 PHOTOCOPY_COLOR (for sources WEB_CAM and REDIRECT_CAM) 104 DIGITAL_COPY 200 NOT_READABLE_DOCUMENT 201 NO_DOCUMENT 202 SAMPLE_DOCUMENT 206 MISSING_BACK 207 WRONG_DOCUMENT_PAGE 209 MISSING_SIGNATURE 210 CAMERA_BLACK_WHITE 211 DIFFERENT_PERSONS_SHOWN (documents of multiple people in one image) 300 MANUAL_REJECTION |
| rejectReasonDetails | Object | Reject reason details as JSON array containing JSON objects if rejectReasonCode = 100 or 200, see table below |
| Parameter "rejectReasonDetails" | Type | Max. Length | Description |
|---|---|---|---|
| detailsCode | String | 5 | see below |
| detailsDescription | String | 32 | Possible codes and descriptions for rejectReasonCode = 100: 1001 PHOTO 1002 DOCUMENT_NUMBER 1003 EXPIRY 1004 DOB 1005 NAME 1006 ADDRESS 1007 SECURITY_CHECKS 1008 SIGNATURE 1009 PERSONAL_NUMBER 10011 PLACE_OF_BIRTH Possible codes and descriptions for rejectReasonCode = 200: 2001 BLURRED 2002 BAD_QUALITY 2003 MISSING_PART_DOCUMENT 2004 HIDDEN_PART_DOCUMENT 2005 DAMAGED_DOCUMENT |
Required items appear in bold type.
| Parameter "identityVerification" | Max. Length | Description |
|---|---|---|
| similarity | Possible values: • MATCH • NO_MATCH • NOT_POSSIBLE |
|
| validity | Possible values: • TRUE • FALSE |
|
| reason | Provided if validity = FALSE Possible values: • SELFIE_CROPPED_FROM_ID • ENTIRE_ID_USED_AS_SELFIE • MULTIPLE_PEOPLE • SELFIE_IS_SCREEN_PAPER_VIDEO • SELFIE_MANIPULATED • AGE_DIFFERENCE_TOO_BIG • NO_FACE_PRESENT • FACE_NOT_FULLY_VISIBLE • BAD_QUALITY • BLACK_AND_WHITE • LIVENESS_FAILED |
|
| handwrittenNoteMatches | Only visible if setting is turned on within your account. For questions about this feature, please contact your Support. Possible values: • TRUE • FALSE |
Required items appear in bold type.
| Parameter "dlCategories" | Max. Length | Description |
|---|---|---|
| category | 10 | String in Latin or Traditional Chinese characters |
| issueDate | Issue date in the format YYYY-MM-DD | |
| expiryDate | Date of expiry in the format YYYY-MM-DD as available on the driver license | |
| isReadable | Possible value: • FALSE |
|
| availability | Possible values: • yes • no • not readable |
Extracting certain sensitive information from identity documents in the Netherlands, Germany, and South Korea is prohibited by law for customers with a business presence in those countries. These customers can elect to enable Netverify masking to protect this sensitive data.
When masking is enabled for these countries, certain fields cannot be extracted and returned in the callback. The information contained in these fields is masked before the user's image is stored.
| Country | Document | Affected parameters (not returned in the callback) |
|---|---|---|
| Germany | Passport | idCheckMRZcode, idNumber |
| Germany | ID card | idCheckMRZcode, idNumber |
| Netherlands | Passport | idCheckMRZcode, personalNumber |
| Netherlands | ID card | idCheckMRZcode, personalNumber |
| Netherlands | Driver license | image is masked, no extracted data fields are affected |
| South Korea | Passport | idCheckMRZcode, personalNumber |
| South Korea | ID card | idNumber, idDob |
| South Korea | Driver license | idDob |
idExpiry=2022-12-31&idType=PASSPORT&idDob=1990-01-01&idCheckSignature=OK&idCheckDataPositions=OK&idCheckHologram=OK&idCheckMicroprint=OK&idCheckDocumentValidation=OK&idCountry=USA&idScanSource=SDK&idFirstName=FIRSTNAME&verificationStatus=APPROVED_VERIFIED&jumioIdScanReference=xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx&personalNumber=N%2FA&merchantIdScanReference=YOURIDSCANREFERENCE&idCheckSecurityFeatures=OK&idCheckMRZcode=OK&idScanImage=https%3A%2F%2Fnetverify.com%2Frecognition%2Fv1%2Fidscan%2Fxxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx%2Ffront&callBackType=NETVERIFYID&clientIp=xxx.xxx.xxx.xxx&idLastName=LASTNAME&idAddress=%7B%22country%22%3A%22USA%22%2C%22stateCode%22%3A%22US%2DOH%22%7D&idScanStatus=SUCCESS&identityVerification=%7B%22similarity%22%3A%22MATCH%22%2C%22validity%22%3Atrue%7D&idNumber=P1234
idType=PASSPORT&idCheckSignature=N%2FA&rejectReason=%7B%20%22rejectReasonCode%22%3A%22100%22%2C%20%22rejectReasonDescription%22%3A%22MANIPULATED_DOCUMENT%22%2C%20%22rejectReasonDetails%22%3A%20%5B%7B%20%22detailsCode%22%3A%20%221001%22%2C%20%22detailsDescription%22%3A%20%22PHOTO%22%20%7D%2C%7B%20%22detailsCode%22%3A%20%221004%22%2C%20%22detailsDescription%22%3A%20%22DOB%22%20%7D%5D%7D&idCheckDataPositions=N%2FA&idCheckHologram=N%2FA&idCheckMicroprint=N%2FA&idCheckDocumentValidation=N%2FA&idCountry=USA&idScanSource=SDK&verificationStatus=DENIED_FRAUD&jumioIdScanReference=xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx&merchantIdScanReference=YOURSCANREFERENCE&idCheckSecurityFeatures=N%2FA&idCheckMRZcode=N%2FA&idScanImage=https%3A%2F%2Fnetverify.com%2Frecognition%2Fv1%2Fidscan%2Fxxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx%2Ffront&callBackType=NETVERIFYID&clientIp=xxx.xxx.xxx.xxx&idScanStatus=ERROR
(formerly Netverify Multi Document)
The following parameters are posted to your callback URL for Document Verification and Document Verification API.
Required items appear in bold type.
| Parameter | Type | Max. Length | Description |
|---|---|---|---|
| scanReference | String | 36 | Jumio's reference number for each scan |
| timestamp | String | Timestamp (UTC) of the response format: YYYY-MM-DDThh:mm:ss.SSSZ |
|
| transaction | JSON object | Transaction related data, see table below | |
| document | JSON object | Document related data if transaction status = DONE, see table |
Required items appear in bold type.
| Parameter "transaction" | Type | Max. Length | Description |
|---|---|---|---|
| date | String | Timestamp (UTC) of the scan creation format: YYYY-MM-DDThh:mm:ss.SSSZ |
|
| status | String | Possible states: • DONE • FAILED (if initialized acquisition is not successfully finalized within 5 minutes after creation/last update) |
|
| source | String | Possible values: • DOC_UPLOAD (Document Verification) • DOC_API (Document Verification API) • DOC_SDK (Document Verification Mobile) |
|
| merchantScanReference | String | 255 | Your reference for each scan |
| customerId | String | 255 | ID of the customer |
| merchantReportingCriteria | String | 255 | Your reporting criteria for each scan |
| clientIp | String | 100 | IP address of the client if provided for the Document Verification API |
Required items appear in bold type.
| Parameter "document" | Type | Max. Length | Description |
|---|---|---|---|
| status | String | Possible states: ⦁ UPLOADED (default) ⦁ EXTRACTED if supported document for data extraction provided ⦁ DISCARDED if no supported document for data extraction provided |
|
| country | String | 3 | Possible countries: ⦁ ISO 3166-1 alpha-3 country code ⦁ XKX (Kosovo) |
| type | String | Possible types: ⦁ CC (Credit card, front and back side) ⦁ BS (Bank statement, front side) ⦁ IC (Insurance card, front side) ⦁ UB (Utility bill, front side) ⦁ CAAP (Cash advance application, front and back side) ⦁ CRC (Corporate resolution certificate, front and back side) ⦁ CCS (Credit card statement, front and back side) ⦁ LAG (Lease agreement, front and back side) ⦁ LOAP (Loan application, front and back side) ⦁ MOAP (Mortgage application, front and back side) ⦁ TR (Tax return, front and back side) ⦁ VT (Vehicle title, front side) ⦁ VC (Voided check, front side) ⦁ STUC (Student card, front side) ⦁ HCC (Health care card, front side) ⦁ CB (Council bill, front side) ⦁ SENC (Seniors card, front side) ⦁ MEDC (Medicare card, front side) ⦁ BC (Birth certificate, front side) ⦁ WWCC (Working with children check, front side) ⦁ SS (Superannuation statement, front side) ⦁ TAC (Trade association card, front side) ⦁ SEL (School enrolment letter, front side) ⦁ PB (Phone bill, front side) ⦁ SSC (Social security card, front side) ⦁ CUSTOM (Custom document type) ⦁ OTHER (Other document type) |
|
| images | JSON array | URLs to the images of the scan (JPEG or PNG)1 | |
| originalDocument | String | URL to the originally submitted document of the scan (PDF) if available1 | |
| customDocumentCode | String | 100 | Your custom document code (maintained in your Jumio customer portal) if type = CUSTOM |
| extractedData | JSON object | Extracted data if status = EXTRACTED, see Supported documents for Data Extraction |
1 Retrieve the images of the transaction.
Use HTTP: GET with Basic Authorization using your API token and secret, as userid and password.
Header: The following parameters are mandatory in the "header" section of your request.
Accept: image/jpeg, image/pngUser-Agent: YOURCOMPANYNAME YOURAPPLICATIONNAME/VERSION
The value for User-Agent must contain a reference to your business or entity for Jumio to be able to identify your requests. (e.g. YourCompanyName YourAppName/1.0.0). Without a proper User-Agent header, Jumio will take longer to diagnose API issues.
The TLS protocol is required during the TLS handshake (see Supported cipher suites) and we strongly recommend using the latest version.
| Parameter "extractedData" | Type | Max. Length | Description |
|---|---|---|---|
| firstName | String | 255 | First name if readable |
| lastName | String | 255 | Last name if readable |
| name | String | 100 | Full name if readable |
| accountNumber | String | 28 | Bank account number of the customer from a bank statement |
| pan | String | 20 | Personal account number of credit card |
| issueDate | String | Issue date in the format YYYY-MM-DD | |
| expiryDate | String | Date of expiry in the format YYYY-MM-DD | |
| ssn | String | 255 | Social security number if readable |
| signatureAvailable | String | "true" if signature available, otherwise "false" | |
| swiftCode | String | 20 | BIC/SWIFT code |
| address | JSON object | Address as JSON object in raw format if status = EXTRACTED, see table below |
| Parameter "address" | Max. Length | Description |
|---|---|---|
| line1 | 100 | Line item 1 |
| line2 | 100 | Line item 2 |
| line3 | 100 | Line item 3 |
| line4 | 100 | Line item 4 |
| line5 | 100 | Line item 5 |
| countryCode | 3 | Possible countries of residence: • ISO 3166-1 alpha-3 country code • XKX (Kosovo) |
| postalCode | 15 | Postal code |
| city | 64 | City |
| subdivision | 50 | Name of subdivision |
Name, Address, and Issuing Date will be extracted for all documents printed in a Latin-script character set, provided that a minimum of two of these three data points are available for extraction. If the document does not meet these extraction criteria, only the document image will be saved — no data extraction will be performed.
For the following specific document types, additional data will be extracted.
| Type | Extracted data |
|---|---|
| BS (bank statement) | name, issueDate, address, accountNumber, swiftCode |
| CC (credit card) | name, pan, expiryDate |
| UB (utility bill) | name, issueDate, address, dueDate |
| CCS (credit card statement) | name, issueDate, address, cardNumberLastFourDigits |
| SSC (Social Security card)1 | firstName, lastName, ssn, signatureAvailable |
1 USA only.
timestamp=2017-06-06T12%3A06%3A49.016Z&scanReference=xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx&document=%7B%22type%22%3A%22SSC%22%2C%22country%22%3A%22AUT%22%2C%22images%22%3A%5B%22https%3A%2F%2Fretrieval.netverify.com%2Fapi%2Fnetverify%2Fv2%2Fdocuments%2Fxxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx%2Fpages%2F1%22%5D%2C%22status%22%3A%22UPLOADED%22%7D&transaction=%7B%22customerId%22%3A%22CUSTOMERID%22%2C%22date%22%3A%222014-10-17T06%3A37%3A51.969Z%22%2C%22merchantScanReference%22%3A%22YOURSCANREFERENCE%22%2C%22source%22%3A%22DOC_SDK%22%2C%22status%22%3A%22DONE%22%7D
timestamp=2017-06-06T12%3A06%3A49.016Z&scanReference=xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx&document=%7B%22type%22%3A%22SSC%22%2C%22country%22%3A%22USA%22%2C%22extractedData%22%3A%7B%22firstName%22%3A%22FIRSTNAME%22%2C%22lastName%22%3A%22LASTNAME%22%2C%22signatureAvailable%22%3Atrue%2C%22ssn%22%3A%22xxxxxxxxx%22%7D%2C%22images%22%3A%5B%22https%3A%2F%2Fretrieval.netverify.com%2Fapi%2Fnetverify%2Fv2%2Fdocuments%2Fxxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx%2Fpages%2F1%22%5D%2C%22status%22%3A%22EXTRACTED%22%7D&transaction=%7B%22customerId%22%3A%22CUSTOMERID%22%2C%22date%22%3A%222014-10-17T06%3A37%3A51.969Z%22%2C%22merchantScanReference%22%3A%22YOURSCANREFERENCE%22%2C%22source%22%3A%22DOC_SDK%22%2C%22status%22%3A%22DONE%22%7D
timestamp=2017-06-06T12%3A06%3A49.016Z&scanReference=xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx&document=%7B%22type%22%3A%22SSC%22%2C%22country%22%3A%22USA%22%2C%22images%22%3A%5B%22https%3A%2F%2Fretrieval.netverify.com%2Fapi%2Fnetverify%2Fv2%2Fdocuments%2Fxxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx%2Fpages%2F1%22%5D%2C%22status%22%3A%22DISCARDED%22%7D&transaction=%7B%22customerId%22%3A%22CUSTOMERID%22%2C%22date%22%3A%222014-10-17T06%3A37%3A51.969Z%22%2C%22merchantScanReference%22%3A%22YOURSCANREFERENCE%22%2C%22source%22%3A%22DOC_SDK%22%2C%22status%22%3A%22DONE%22%7D
If your server was not able to process the callback, which is the authoritative answer from Jumio, you can implement RESTful HTTP GET APIs to retrieve the status, details and image(s) for a specific scan. The implementation guide can be viewed via the link below.
© Jumio Corp. 268 Lambert Avenue, Palo Alto, CA 94306