Retail ID Online Migration to Capture

Applies to: Direct

❗️

Intellicheck Retail ID Online will be decommissioned on March 31, 2025. Customers must migrate to Intellicheck Capture no later than March 15, 2025.

This page provides an overview of the steps required to migrate to Intellicheck Capture. This information applies to existing Intellicheck Direct customers who are maintaining an older codebase that Intellicheck no longer supports. Read this page if you were contacted by Intellicheck with information about a required migration off Retail ID Online.

High-level overview

At a high level, the migration process includes the following steps:

• Investigate the requirements and understand what is involved (you're doing that now).
• Familiarize yourself with the process outlined here to begin planning your code rewrites.
• Decide if you want to engage with our solutions engineering team (separate charges may apply).
• Contact Intellicheck support to request credentials to our Sandbox environment where you can test your new integration.
• Ensure your solution follows our best practices for security and data handling.
• After testing, we'll help you go live.

👍

Our new environment provides many benefits compared to the legacy environment, including enhanced security and built-in redundancy. Intellicheck will no longer support Retail ID Online. All migration must be completed no later than March 15, 2025.

---

Continue reading to learn more about the process you'll follow to rewrite your code and integrate Capture.

For assistance or further questions, please open a support ticket: Capture Migration Credential and Help Request Form

---

Request your credentials for our new Capture API

Our team will create credentials for you in our new Sandbox environment. Please open a support ticket at Capture Migration Credential and Help Request Form to request your new Capture API credentials. You'll receive a secure email with those credentials within 48 hours of telling us you want to start code rewrites. That secure email will expire 24 hours after it is sent, so please save the credentials before then.

• Sandbox Base URL: https://direct-sandbox.intellicheck.com/

Review the new API requirements

The getting started section provides developers with details on data encryption, requirements, response types, and testing environments for the new API.

• Getting Started with Direct

Familiarize yourself with the new API documentation

Learn how the new API is documented so you can prepare your requests and understand our response objects.

• API reference overview

Use our API explorer

Our developer portal includes an interactive API explorer with a Try It button to simulate requests and responses.

• Learn about the API explorer

New API endpoint details

Get familiar with the most important API endpoints described below.

Start transaction endpoint

This endpoint begins the capture process.

• See it here--> /start

Many Retail ID Online implementations require a postback URL. You can send a /start request with a postback URL by specifying the results_url parameter in the public_data request object, as shown here.

JSON

{
  "public_data": {
    "capture_language": "en-us",
    "results_url": "https://www.examplepostbackurl.com"
  },
  "private_data": {
    "document_type": "na_dl",
    "send_link": {
      "type": "sms",
      "to": "[phone]"
    },
    "signals": [
      "idcheck"
    ]
  }
}

Get results endpoint

If you don't have (or want) a postback address, you can poll for results with the /get-results endpoint.

• See it here --> /get-results

👍

Polling for results is not available in legacy Retail ID Online. It's only available in our Capture experience.

Use Code examples and recipes

We whipped up a few recipes with annotated code examples to help you get started. Take a look.

• Recipes

Get status codes

You get all-new status codes to track your customer journey.

• Status codes

Investigate response objects

Results come back in familiar response objects. Here are a few pages with descriptions and object schemas for barcode results (idcheck object), front-side results (OCR object), and selfie results (facial object).

• idcheck
• OCR
• facial

Make sure to check out the other response object schemas in the Results section. There are several additional ones only available with the new environment, such as customer quality signals and document liveness.

Here is a quick rundown of each response type for some of the most common request use cases.

Request	Response Object
Barcode only	idcheck
Back-to-front data matching	ocr_match
Face matching and selfie liveness	selfie
MRZ on passports and other documents	extendedID
Customer device quality checks	addressDetails fraudDetails phoneDetails
Document liveness	document_liveness_idrnd

Find validation results

Here are some response object properties to help quickly determine validation and decisioning status.

Validation Type	Status Property
Barcode	processResult
OCR and extended ID	documentRecognized
Selfie	matched
Device	fraud_score