Apply - Cards API

This API allows users to apply for a card using a specified program ID.
The request includes the program details and, if applicable, KYC (Know Your Customer) information as required by the card program's KYC policies.

KYC (Know Your Customer) information required for the card application.

If the kycRequirements are null and kycRequiredWhileApplyCard is false, KYC information is not necessary.

If KYC information is required based on the card program's policies, the object must contain the necessary fields as per the program's KYC requirements.

Request

Header Params

Content-Type

string

optional

Default:

application/json

Authorization

string

optional

Default:

Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c

Body Params application/json

programId

string

optional

kyc

object

optional

If the Kycrequirements are null, then KYC information is not needed. However, if the Kycrequirements have a value and kycRequiredWhileApplyCard is true, the KYC information must be provided. In this case, ensure that the required fields are passed based on the program's KYC requirements. Otherwise, KYC information is not required.

firstName

string

optional

First Name of the individual

lastName

string

optional

Last Name of the individual

gender

integer

optional

Gender (1: male, 2: female)

dob

string

optional

Birthday (yyyy-MM-dd)

nationalityId

string

optional

nationalityId. Please call the interface /Countries

string

optional

mobileCode

string

optional

Mobile Code (country code)

mobile

string

optional

Mobile Number

address

string

optional

Residential address

town

string

optional

Town Code. Please call the interface /Towns

city

string

optional

City

state

string

optional

State or region

zipCode

string

optional

Postal Code

countryId

string

optional

Country Id Please call the interface /Countries

countryIsoThree

string

optional

countryIsoThree Please call the interface /Countries

emergencyContact

string

optional

Emergency Contact Number

docType

integer

optional

Document Type (1 for passport)

docId

string

optional

Document ID

frontDoc

string

optional

frontdoc: Encoded into base64 format. The size of this field should be less than 1 MB. Support：jpg,jpeg,png

backDoc

string

optional

backdoc: Encoded into base64 format. The size of this field should be less than 1 MB. Support：jpg,jpeg,png

docExpireDate

string

optional

Expiry date of the document

docNeverExpire

integer

optional

Indicates if the document has never expired (0 for no)

handHoldIdPhoto

string

optional

handHoldIdPhoto: Encoded into base64 format. The size of this field should be less than 1 MB. Support：jpg,jpeg,png

bioMatric

string

optional

bioMatric: Encoded into base64 format. The size of this field should be less than 1 MB. Support：jpg,jpeg,png

photo

string

optional

photo: Encoded into base64 format. The size of this field should be less than 1 MB. Support：jpg,jpeg,png

signImage

string

optional

signImage: Encoded into base64 format. The size of this field should be less than 1 MB. Support：jpg,jpeg,png

Example

{
  "programId": "667c63ed-9187-4b1a-be64-8190c8d7ab2b",
  "kyc":  {
    "firstName": "cameron",
    "lastName": "green",
    "gender": 1,
    "dob": "2000-10-01",
    "nationalityId": "+91",
    "email": "[email protected]",
    "mobileCode": "+91",
    "mobile": "9398889038",
    "address": "hyderbad",
    "town": "Srnagar",
    "city": "city",
    "state": "Ts",
    "zipCode": "500038",
    "countryId": "+91",
    "countryIsoThree": "countryIsoThree",
    "emergencyContact": "98709870987",
    "docType": 1,
    "docId": "1",
    "frontDoc": "frontimg",
    "backDoc": "backimg",
    "docExpireDate": "2025-10-01",
    "docNeverExpire": 0,
    "handHoldIdPhoto": "10-01-2025",
    "bioMatric": "Finger",
    "photo": "img",
    "signImage": "sigimg"
  } 
}

Responses

🟢200OK

text/plain

Success

Body

cardId

string | null

optional

CardId

status

string | null

optional

Status(Success,Failed)

remarks

string | null

optional

Status description

Example

{
    "cardid": "c1b4d39b-7a60-48b7-9bf2-d3fe20d3fdef",
    "status": "Success",
    "remarks": "Description"
}

🟠400Bad Request

🟠401Unauthorized

🟠403Forbidden

🟠404Record Not Found

🔴500Server Error

🔴501501