CFWeb Verify API

This API call is used to initiate a request to validate a person’s identity, as well as define the CFWeb workflow and define values that need to be in that Postback or Status API response after a transaction is completed.  A Login API (JWT token) or a CF Web Certificate is required to use this API.

Note: If the configurable parameters are missing from the Verify API, customers will be unable to obtain images and certain PII data later.

Terminology

Terminology Description
Merchant The enterprise company that initiates a request for a customer to verify their identity.
Customer The individual submitting their identification for verification.
CFWeb Server Validates and sends requests.
Selfie An optional feature that can be enabled or disabled.
Document Type

The document types are:

  • ID1 documents not limited to this list; (Drivers License Card, Weapons License Card, Identity Card, Passport Card, etc.).

  • ID-2 documents (South African Green ID book, Romanian ID cards).

  • ID-3 documents (Passport book and Visa Card).

Retrieving Data From System

CFWeb server offers three methods to retrieve data from the system: Status API using requestID, Status API using a UID, and Postback to a customer-defined URL. Data is returned using one of the two postback mechanisms. 1. We call the Merchant, and the customer will configure Postback, and 2. CFWeb calls this URL using the POST method.

Note: For retrieval of submitted images from CFWeb Server use the channelResponse to specify the image types, see channelResponse section.
API & Postback Type Method
api/status Response Returned GET Postback for request using the RequestID
api/status/uid Response Returned GET Postback for transaction using the UID

Postback to URL

(provided by enterprise customer)

 Response Sent to Postback URL

POST Postback for transaction and request

(To a customer-defined URL)

Topics in this section: