Find out how Cipher REST APIs can be integrated into the Card Management System (CMS) or other such systems to trigger updates on Cipher System. Find out Cipher Offering here.
In this article, you will learn how to use the Cipher APIs and then build your own Two Factor Authentication (2FA).
This endpoint allows you to enroll cards for authentication along with the cardholder’s identification information and challengeable identities. The API supports enrollment using either of the following enrollment options:
/tenants/{tenantId}/cards |
|
|
This endpoint allows you to enable or disable a card using its cardId
.
/tenants/{tenantId}/cards/{cardId} |
|
|
This endpoint allows you to retrieve details of a tenant. A tenant is an organization or financial institute on-boarded with Zeta.
/tenants/{tenantId} |
|
|
This endpoint allows you to fetch the enrollment details of a cardholder, including the identity types.
/tenants/{tenantId}/cardHolders/{cardHolderId} |
|
|
This endpoint allows you to update the identities of a cardholder. Currently, the Cipher system supports identities such as phone numbers and email. You can update any one or both identities at a time. You can use the identity in a challenge verification only if it is enabled in your product.
/tenants/{tenantId}/cardHolders/{cardHolderId}/identities |
|
|
This section explains the various error codes thrown by Cipher APIs.
The sample error response below shows server-side error code and message returned in case of any error:
{ "code": "ER001", "message": "Bad request", "debugId": "9551a715-79d4-4b64-a3d8-11efe7610baf" } |
The following table lists the error codes, descriptions and possible solutions. If the issue persists, contact Zeta.
Error Code | Error Message | HTTP Status |
| Unexpected server error occurred | 500 |
| Bad request | 400 |
| Conflicting input | 409 |
| Resource not found | 404 |
| Unauthorized action | 401 |
|