Major and Minor REST APIs
Major APIs
| API Name | Description |
|---|---|
| Get User Detail | Get User Detail returns a response with access details; for the user’s Username and Password. |
| Authenticate Document | This stand-alone API generates a transaction ID, document, and transaction submission details. |
| Authenticate Face |
Customers can authenticate previously existing customer accounts independently. |
| Enroll Face |
EnrollFace API is a way for our customers to enroll and authenticate new customer accounts independently. |
| UnEnroll Face |
Enroll Face is a way for our customers to enroll and authenticate customer accounts independently. |
| Enrollment & Re-authentication |
Enrolling and Re-authenticating new and existing customers. |
| Update Transaction |
The update transaction amends existing transaction details with key-value pairs. |
| Get Segment Name |
Get Segment Name request returns 12 lines with the Transaction ID, segment name, and action code. |
| MatchSelfie API Call |
Match Selfie is dependent on AuthenticateDocument to verify the user identity for Transaction ID. |
| MatchFace API Call | MatchFace uses the liveness selfie image to create a grid and the document profile photo to score the two images for likeness. |
Minor APIs
| API Name | Description |
|---|---|
| Get Transaction Info |
This stand-alone API generates a Transaction ID, document, and transaction submission details. This API is the same as the Authenticate Document Response. Note: You can use Get Transaction Info to re-request the transaction ID and generate result details.
|
| Get Location | Get Location gets your unique account location code. |
| Get Status | Get Status is your status health check. |
| Get Version | Get Version is the CatFishAir version release number currently in use. |
