- Created by Seema, last modified by Pooja on Jun 12, 2020
You are viewing an old version of this page. View the current version.
Compare with Current View Page History
« Previous Version 5 Next »
Learn how you can use the Cipher APIs and then build your own Two Factor Authentication (2FA). 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. |
Create Card
This endpoint allows you to enroll cards for authentication using the cardholder’s challengeable identities. The API supports enrollment using the following card schemes:
- 15/16-digit card PAN
- SHA256 of the card
Endpoint URI
Request details
Request parameters
Request sample
Parameter | Description |
---|---|
Body parameters | |
String, Required | Name of the cardholder. |
String, Required | Type of schemes to enroll cards in Cipher:
|
Integer, Required | A 15/16-digit number on the payment card. |
String, Optional | Type of identity challenged to authenticate the cardholder. Supported types:
|
String, Optional | Value of the specified identity type. |
String, Optional | Desired state of a card.
|
{ "name": "Foo Bar", "cardInfo" : { "scheme" : "DEFAULT", "cardNumber" : "111111844739172" }, "identities": [ { "type" : "tenantUniqueVector", "value" : "990011223" }, { "type": "phoneNumber", "value": "+919999999999" } ], "state": "ENABLED" }
Response details
Response parameters
Response sample
Parameter | Description |
---|---|
Integer | The card reference ID generated on the Cipher system. |
String | Card Globally Unique Identifier. In Cipher, whenever a card is enrolled , at Zeta an alias is created for it called |
String | Name of the cardholder. |
Integer | ID of the tenant generated on the Cipher system. |
Integer | ID of the product generated on the Cipher system. |
String | Name of the product generated on the Cipher system. |
Integer | The
|
Integer | A 15/16-digit number on the payment card. |
String | Type of network used to manage payments. Examples: Visa and Mastercard. |
String | Desired state of a card.
|
String | Type of identity challenged to authenticate the cardholder. Supported types:
|
String | A value for a given type of identity used to authenticate the cardholder. |
String | Desired state of the identity for authentication. |
{ "cardId": "CRN0000000050", "cardGuid": "5f90a3d8-8b59-441f-95cd-2e1b3fb680ee", "name": "Foo Bar", "tenantId": "900912", "productId": "PRO00103", "productName": "My Amex Product", "authProfileId": "_aP56QPq1U03wFTq_lNBqg==", "cardNumber": "111111xxxxxx172", "cardNetwork": "amex", "state": "ENABLED", "identities": [ { "type": "cardGuid", "value": "5f90a3d8-8b59-441f-95cd-2e1b3fb680ef", "state": "ENABLED" }, { "type": "tenantUniqueVector", "value": "990011223", "state": "ENABLED" }, { "type": "phoneNumber", "value": "+919999999999", "state": "ENABLED" } ] }
Update Card
This endpoint allows you to enable or disable a card using its cardId
.
Endpoint URI
Request details
Request parameters
Request sample
Parameter | Description |
---|---|
Body parameters | |
String, Required | Desired state of a card.
|
{ "state":"DISABLED" }
Response details
Response parameters
Response sample
Parameter | Description |
---|---|
Integer | The card reference ID generated on the Cipher system. |
String | Card Globally Unique Identifier. In Cipher, whenever a card is enrolled , at Zeta an alias is created for it called |
String | Name of the cardholder. |
Integer | ID of the tenant generated on the Cipher system. |
Integer | ID of the product generated on the Cipher system. |
Integer | Name of the product generated on the Cipher system |
Integer | The
|
Integer | A 15/16-digit number on the payment card. |
Integer | Type of network used to manage payments between card issuing banks and merchant banks. Examples: Visa and Mastercard. |
String | Type of identity challenged to authenticate the cardholder. Supported types:
|
String | A value for a given type of identity used to authenticate the cardholder. |
String | Desired state of the identity for authentication. |
{ "cardId": "CRN0000000050", "cardGuid": "5f90a3d8-8b59-441f-95cd-2e1b3fb680ee", "name": "Foo Bar", "tenantId": "900912", "productId": "PRO00103", "productName": "My Amex Product", "authProfileId": "_aP56QPq1U03wFTq_lNBqg==", "cardNumber": "111111xxxxxx172", "cardNetwork": "amex", "state": "DISABLED", "identities": [ { "type": "cardGuid", "value": "5f90a3d8-8b59-441f-95cd-2e1b3fb680ef", "state": "ENABLED" }, { "type": "tenantUniqueVector", "value": "990011223", "state": "ENABLED" }, { "type": "phoneNumber", "value": "+919999999999", "state": "ENABLED" } ] }
Get Tenant
This endpoint allows you to retrieve details of a tenant. A tenant is an organization or financial institute on-boarded with Zeta.
Endpoint URI
Request details
Request parameters
Parameter | Description |
---|---|
Query parameters | |
Integer, Required | ID of the tenant generated on the Cipher system. |
Response details
Response parameters
Response sample
Parameter | Description |
---|---|
Integer | ID of the tenant generated on the Cipher system. |
String | Name of the tenant. A tenant is an organization or financial institute on-boarded with Zeta. |
String | Configurations for look and feel of the authentication page.
|
String | Desired state of a card.
|
authPlans String | A collection of authentication plans that are available to choose from for configuring the authentication experience of the cardholder . Currently, we support single factor authentication plans like SMS_OTP, email_OTP, and Super PIN. |
{ "tenantId": "900912", "name": "HDFC", "config": { "gaID": "ga_id_amzn_fstv", "logoURL": "https://sample.svg", "templateConfig": { "bannerBgColor": "#ebebeb", "linkTextColor": "#7d52cd", "activeBtnColor": "#7d52cd", "bannerTextColor": "#222", "disabledBtnColor": "#cfcfcf", "primaryTextColor": "#222", "secondaryTextColor": "#030303" }, "challengeConfig": { "resendOTPLimit": 3, "incorrectChallengeAttemptLimit": 2 }, "authExpiryInSeconds": 300 }, "state": "ENABLED", "authPlans": [ { "authPlanId": 1, "factors": [ { "factorNumber": 1, "identities": [ { "identityType": "phoneNumber" } ] } ] } ] }
- No labels