Customers

Summary

The Customers API allows you to retrieve basic Citi customer information like name, mailing address, email address and phone numbers.

Want to try this API out on our Playground?

Go play now

Endpoints on this page

post /v1/in/customers/identity/otp	Trigger an OTP from UIDAI
post /v1/in/customers/identity/kyc	Retrieve KYC Information from Aadhaar
get /partner/v1/customers/profiles	Retrieve Customer Personal Details from Partner
get /v1/sales/customers/offers/details	Retrieve Offer Details

Trigger an OTP from UIDAI

post /v1/in/customers/identity/otp

Description

This API is used to trigger one time password (OTP) from UIDAI to the Aadhaar Number given by customer in the credit card application form. The OTP is delivered to the mobile number and/or email id linked to Aadhaar Number.

Swagger

Header Parameters

Authorization

string required

The most recent Authorization token. This will have the format Bearer + {space} + {accessToken}. Example: Bearer KGNsaWVudF9pZDpjbGllbnRfc2VjcmV0KQ==.

uuid

string required

128 bit random UUID generated uniquely for every request.

string required

Content-Type that are acceptable for the response.

client_id

string required

Client ID generated during application registration.

Content-Type

string required

application/json

clientDetails

string Optional

This field is used to capture device,browser and network information. Refer the developer portal for more information.These are the fields which will be passed as part of the header devicePrint,deviceTokenCookie,userIpAddress,userAgent,hardwareId,simId,deviceModel,deviceName,deviceOsName,deviceOsVersion,multitaskingSupportFlag,languageSupport,wifiMacAddress,cellTowerId,locationAreaCode,rsaApplicationKey,wapClientId,mobileCarrierCode,mobileCountryCode,osId,geoLongitude,geoLatitude,geoHorizontalAccuracy,geoAltitude,geoAltitudeAccuracy,geoSpeed,geoTimestamp,geoStatus,basicServiceSetId,signalStrength,wifiChannel,serviceSetId

Body Parameters

AadhaarOtpRequest

required

AadhaarOtpRequest

{
    "properties": {
        "aadhaarNumber": {
            "description": "Aadhaar Number",
            "type": "string",
            "example": "873487387487"
        },
        "customerReferenceKey": {
            "description": "Customer reference key.This is a reference data field. Please use \/utilities\/referenceData\/{customerReferenceKey} resource to get valid values of this field with descriptions",
            "type": "string",
            "example": "APPLICATION_ID"
        },
        "customerReferenceValue": {
            "description": "Cusomer reference key value",
            "type": "string",
            "example": "SG5345324"
        }
    },
    "required": [
        "aadhaarNumber",
        "customerReferenceKey",
        "customerReferenceValue"
    ]
}

cURL
Ruby
Python
PHP
Java
Node
Go
Swift

Example Request

Responses

Successful operation.

Definitions

transactionId
- Transaction Id for subsequent API request
- type : string

Example Response for post /v1/in/customers/identity/otp

Type	Code	Details
invalid	invalidRequest	Missing or invalid Parameters

Definitions

type
- Invalid - Request did not confirm to the specification and was unprocessed and rejected. Please fix the value and try again
- enum : error, warn, invalid, fatal
- type : string
code
- Error code which qualifies the error
- type : string
details
- Human readable explanation specific to the occurrence of the problem
- type : string
location
- The name of the field that resulted in the error
- type : string
moreInfo
- URI to human readable documentation of the error
- type : object
required
- type
- code

Response Schema for post /v1/in/customers/identity/otp

{
    "properties": {
        "type": {
            "description": "Invalid - Request did not confirm to the specification and was unprocessed and rejected. Please fix the value and try again",
            "enum": [
                "error",
                "warn",
                "invalid",
                "fatal"
            ],
            "type": "string"
        },
        "code": {
            "description": "Error code which qualifies the error",
            "type": "string"
        },
        "details": {
            "description": "Human readable explanation specific to the occurrence of the problem",
            "type": "string"
        },
        "location": {
            "description": "The name of the field that resulted in the error",
            "type": "string"
        },
        "moreInfo": {
            "description": "URI to human readable documentation of the error",
            "type": "object"
        }
    },
    "required": [
        "type",
        "code"
    ]
}

error

unAuthorized

Authorization credentials are missing or invalid

Definitions

type
- Invalid - Request did not confirm to the specification and was unprocessed and rejected. Please fix the value and try again
- enum : error, warn, invalid, fatal
- type : string
code
- Error code which qualifies the error
- type : string
details
- Human readable explanation specific to the occurrence of the problem
- type : string
location
- The name of the field that resulted in the error
- type : string
moreInfo
- URI to human readable documentation of the error
- type : object
required
- type
- code

Response Schema for post /v1/in/customers/identity/otp

{
    "properties": {
        "type": {
            "description": "Invalid - Request did not confirm to the specification and was unprocessed and rejected. Please fix the value and try again",
            "enum": [
                "error",
                "warn",
                "invalid",
                "fatal"
            ],
            "type": "string"
        },
        "code": {
            "description": "Error code which qualifies the error",
            "type": "string"
        },
        "details": {
            "description": "Human readable explanation specific to the occurrence of the problem",
            "type": "string"
        },
        "location": {
            "description": "The name of the field that resulted in the error",
            "type": "string"
        },
        "moreInfo": {
            "description": "URI to human readable documentation of the error",
            "type": "object"
        }
    },
    "required": [
        "type",
        "code"
    ]
}

error

accessNotConfigured

The request operation is not configured to access this resource

Definitions

type
- Invalid - Request did not confirm to the specification and was unprocessed and rejected. Please fix the value and try again
- enum : error, warn, invalid, fatal
- type : string
code
- Error code which qualifies the error
- type : string
details
- Human readable explanation specific to the occurrence of the problem
- type : string
location
- The name of the field that resulted in the error
- type : string
moreInfo
- URI to human readable documentation of the error
- type : object
required
- type
- code

Response Schema for post /v1/in/customers/identity/otp

{
    "properties": {
        "type": {
            "description": "Invalid - Request did not confirm to the specification and was unprocessed and rejected. Please fix the value and try again",
            "enum": [
                "error",
                "warn",
                "invalid",
                "fatal"
            ],
            "type": "string"
        },
        "code": {
            "description": "Error code which qualifies the error",
            "type": "string"
        },
        "details": {
            "description": "Human readable explanation specific to the occurrence of the problem",
            "type": "string"
        },
        "location": {
            "description": "The name of the field that resulted in the error",
            "type": "string"
        },
        "moreInfo": {
            "description": "URI to human readable documentation of the error",
            "type": "object"
        }
    },
    "required": [
        "type",
        "code"
    ]
}

fatal

serverUnavailable

The request failed due to an internal error

Definitions

type
- Invalid - Request did not confirm to the specification and was unprocessed and rejected. Please fix the value and try again
- enum : error, warn, invalid, fatal
- type : string
code
- Error code which qualifies the error
- type : string
details
- Human readable explanation specific to the occurrence of the problem
- type : string
location
- The name of the field that resulted in the error
- type : string
moreInfo
- URI to human readable documentation of the error
- type : object
required
- type
- code

Response Schema for post /v1/in/customers/identity/otp

{
    "properties": {
        "type": {
            "description": "Invalid - Request did not confirm to the specification and was unprocessed and rejected. Please fix the value and try again",
            "enum": [
                "error",
                "warn",
                "invalid",
                "fatal"
            ],
            "type": "string"
        },
        "code": {
            "description": "Error code which qualifies the error",
            "type": "string"
        },
        "details": {
            "description": "Human readable explanation specific to the occurrence of the problem",
            "type": "string"
        },
        "location": {
            "description": "The name of the field that resulted in the error",
            "type": "string"
        },
        "moreInfo": {
            "description": "URI to human readable documentation of the error",
            "type": "object"
        }
    },
    "required": [
        "type",
        "code"
    ]
}

Retrieve KYC Information from Aadhaar

post /v1/in/customers/identity/kyc

Description

This API is used to check the validity of Aadhaar and to receive KYC information about the Aadhaar holder.

Swagger

Header Parameters

Authorization

string required

The most recent Authorization token. This will have the format Bearer + {space} + {accessToken}. Example: Bearer KGNsaWVudF9pZDpjbGllbnRfc2VjcmV0KQ==.

uuid

string required

128 bit random UUID generated uniquely for every request.

string required

Content-Type that are acceptable for the response.

client_id

string required

Client ID generated during application registration.

Content-Type

string required

application/json

clientDetails

string Optional

Body Parameters

AadhaarEkycRequest

required

AadhaarEkycRequest

{
    "properties": {
        "aadhaarNumber": {
            "description": "Aadhaar Number",
            "type": "string",
            "example": "873487387487"
        },
        "customerReferenceKey": {
            "description": "Customer reference key.This is a reference data field. Please use \/utilities\/referenceData\/{phoneCountryCode} resource to get valid values of this field with descriptions",
            "type": "string",
            "example": "APPLICATION_ID"
        },
        "customerReferenceValue": {
            "description": "Cusomer reference key value",
            "type": "string",
            "example": "SG5345324"
        },
        "residentConsentGivenFlag": {
            "description": "Consent from the holder of the Aadhaar Number to initiate the authentication request.",
            "type": "boolean",
            "example": true
        },
        "verificationType": {
            "description": "It specify  authentication  type and possible values are BIOMETRIC_IDENTITY or OTP.",
            "type": "string",
            "example": "OTP"
        },
        "otp": {
            "description": "One time password",
            "type": "string",
            "example": "45683"
        },
        "retrieveKycDetailsFlag": {
            "description": "If the KYC information is to be sent back in the response",
            "type": "boolean",
            "example": true
        },
        "transactionId": {
            "description": "Transaction reference Id as returned by Otp Request API",
            "type": "string",
            "example": "adf44sfsdf234sdfsfsf"
        },
        "biometricIdentity": {
            "properties": {
                "deviceDetails": {
                    "properties": {
                        "hostDeviceCode": {
                            "description": "Unique Host Device Code. This is a unique code for the host. device assigned within the Authentication User Agency domain. This is an alpha-numeric string of. maximum length 20.",
                            "type": "string",
                            "example": "164ASDF6335"
                        },
                        "deviceProviderId": {
                            "description": "Unique code assigned to registered device provider. Returned by  device provider s. registered devices service when using biometric authentication",
                            "type": "string",
                            "example": "MORPHOPOCDPID"
                        },
                        "registeredDeviceServiceId": {
                            "description": "Unique ID of the certified registered device service. Returned by device provider s. registered devices service when using biometric authentication",
                            "type": "string",
                            "example": "MORPHOPOCDPID"
                        },
                        "registeredDeviceServiceVersion": {
                            "description": "Registered devices service version. Returned by device provider s. registered devices service when using biometric authentication",
                            "type": "string",
                            "example": "2.0.0"
                        },
                        "registereddeviceCode": {
                            "description": "Unique Registered Device Code. Returned by device provider s. registered devices service when using biometric authentication",
                            "type": "string",
                            "example": "f85a5b70-YYYY-XXXX-ac25-8d1e9c24680c"
                        },
                        "deviceModelId": {
                            "description": "Registered device model Id.Returned by device provider s. registered devices service when using biometric authentication",
                            "type": "string",
                            "example": "MORPHOPOCMI"
                        },
                        "devicePublicKeyCertificate": {
                            "description": "This attribute holds registered device public key certificate. This is signed with device provider key.Returned by device provider s. registered devices service when using biometric authentication",
                            "type": "string",
                            "example": [
                                "Base 64 Encoded PEM"
                            ]
                        },
                        "sessionKey": {
                            "description": "Value of this element is base-64 encoded value of encrypted 256-bit AES session. key.Session key must be dynamically generated for every transaction. (session key must not be reused) and must not be stored anywhere except. in memory",
                            "type": "string",
                            "example": [
                                "Base 64 Encoded Key"
                            ]
                        },
                        "publicKeyCertificateId": {
                            "description": "Public key certificate Unique identifier using which sessionKey was. encrypted. UIDAI may have multiple public keys in field at the same time. Value of. this attribute is the certificate expiration date in the format \"YYYYMMDD\". Expiry. date of the certificate can be obtained from the certificate itself",
                            "type": "string",
                            "example": "20200916"
                        }
                    },
                    "required": [
                        "hostDeviceCode",
                        "deviceProviderId",
                        "registeredDeviceServiceId",
                        "registeredDeviceServiceVersion",
                        "registereddeviceCode",
                        "deviceModelId",
                        "devicePublicKeyCertificate",
                        "sessionKey",
                        "publicKeyCertificateId"
                    ]
                },
                "personalBiometricData": {
                    "description": "Base-64 Encoded and Encrypted personal Idetity data",
                    "type": "string",
                    "example": [
                        "Base 64 Encoded encrypted PID Block"
                    ]
                },
                "personalBiometricDataBlockFormat": {
                    "description": "Encrypted personal Idetity data type",
                    "type": "string",
                    "example": "X"
                },
                "hmac": {
                    "description": "SHA-256 Hash of Pid block, encrypted and then encoded",
                    "type": "string",
                    "example": "D\/\/gxJcIRCH7h1LVwy\/c9cqLKHYk8HNhUQ7cFeOlofO1BM08tBKHsfDZ+mUonU9g"
                }
            },
            "required": [
                "personalBiometricData",
                "personalBiometricDataBlockFormat",
                "hmac"
            ]
        }
    },
    "required": [
        "aadhaarNumber",
        "customerReferenceKey",
        "customerReferenceValue",
        "residentConsentGivenFlag",
        "verificationType"
    ]
}

cURL
Ruby
Python
PHP
Java
Node
Go
Swift

Example Request

Responses

Successful operation.

Definitions

fullName
- Full name of the Aadhaar number holder as provided by the Aadhaar holder during enrolment or later updates
- type : string
demographics
- - dateOfBirth
    - Aadhaar number holders date of birth in ISO 8601 date format YYYY-MM-DD
    - type : string
    - format : date
  - gender
    - Valid values are "M" for male, "F" for female, and "T" for transgender.
    - type : string
address
- - careOfFullName
    - Aadhaar number holders address care of name as provided by the Aadhaar holder during enrolment or later updates.
    - type : string
  - houseNumber
    - House Number as provided by the Aadhaar holder during enrolment or later updates
    - type : string
  - streetName
    - Street Name as provided by the Aadhaar holder during enrolment or later updates
    - type : string
  - landmark
    - Landmark as provided by the Aadhaar holder during enrolment or later updates
    - type : string
  - locality
    - Locality as provided by the Aadhaar holder during enrolment or later updates
    - type : string
  - villageTownCity
    - This field can contain the name of either village, town or city as provided by the Aadhaar holder during enrolment or later updates
    - type : string
  - subDistrict
    - Sub District as provided by the Aadhaar holder during enrolment or later updates
    - type : string
  - district
    - District name as provided by the Aadhaar holder during enrolment or later updates
    - type : string
  - state
    - State name as provided by the Aadhaar holder during enrolment or later updates
    - type : string
  - postalcode
    - Postal Code name as provided by the Aadhaar holder during enrolment or later updates
    - type : string
  - postoffice
    - Post Office name as provided by the Aadhaar holder during enrolment or later updates
    - type : string
aadhaarNumber
- Aadhaar number
- type : string
transactionId
- Transaction id echoback
- type : string

Example Response for post /v1/in/customers/identity/kyc

Type	Code	Details
invalid	invalidRequest	Missing or invalid Parameters

Definitions

type
- Invalid - Request did not confirm to the specification and was unprocessed and rejected. Please fix the value and try again
- enum : error, warn, invalid, fatal
- type : string
code
- Error code which qualifies the error
- type : string
details
- Human readable explanation specific to the occurrence of the problem
- type : string
location
- The name of the field that resulted in the error
- type : string
moreInfo
- URI to human readable documentation of the error
- type : object
required
- type
- code

Response Schema for post /v1/in/customers/identity/kyc

{
    "properties": {
        "type": {
            "description": "Invalid - Request did not confirm to the specification and was unprocessed and rejected. Please fix the value and try again",
            "enum": [
                "error",
                "warn",
                "invalid",
                "fatal"
            ],
            "type": "string"
        },
        "code": {
            "description": "Error code which qualifies the error",
            "type": "string"
        },
        "details": {
            "description": "Human readable explanation specific to the occurrence of the problem",
            "type": "string"
        },
        "location": {
            "description": "The name of the field that resulted in the error",
            "type": "string"
        },
        "moreInfo": {
            "description": "URI to human readable documentation of the error",
            "type": "object"
        }
    },
    "required": [
        "type",
        "code"
    ]
}

error

unAuthorized

Authorization credentials are missing or invalid

Definitions

type
- Invalid - Request did not confirm to the specification and was unprocessed and rejected. Please fix the value and try again
- enum : error, warn, invalid, fatal
- type : string
code
- Error code which qualifies the error
- type : string
details
- Human readable explanation specific to the occurrence of the problem
- type : string
location
- The name of the field that resulted in the error
- type : string
moreInfo
- URI to human readable documentation of the error
- type : object
required
- type
- code

Response Schema for post /v1/in/customers/identity/kyc

{
    "properties": {
        "type": {
            "description": "Invalid - Request did not confirm to the specification and was unprocessed and rejected. Please fix the value and try again",
            "enum": [
                "error",
                "warn",
                "invalid",
                "fatal"
            ],
            "type": "string"
        },
        "code": {
            "description": "Error code which qualifies the error",
            "type": "string"
        },
        "details": {
            "description": "Human readable explanation specific to the occurrence of the problem",
            "type": "string"
        },
        "location": {
            "description": "The name of the field that resulted in the error",
            "type": "string"
        },
        "moreInfo": {
            "description": "URI to human readable documentation of the error",
            "type": "object"
        }
    },
    "required": [
        "type",
        "code"
    ]
}

error

accessNotConfigured

The request operation is not configured to access this resource

Definitions

type
- Invalid - Request did not confirm to the specification and was unprocessed and rejected. Please fix the value and try again
- enum : error, warn, invalid, fatal
- type : string
code
- Error code which qualifies the error
- type : string
details
- Human readable explanation specific to the occurrence of the problem
- type : string
location
- The name of the field that resulted in the error
- type : string
moreInfo
- URI to human readable documentation of the error
- type : object
required
- type
- code

Response Schema for post /v1/in/customers/identity/kyc

{
    "properties": {
        "type": {
            "description": "Invalid - Request did not confirm to the specification and was unprocessed and rejected. Please fix the value and try again",
            "enum": [
                "error",
                "warn",
                "invalid",
                "fatal"
            ],
            "type": "string"
        },
        "code": {
            "description": "Error code which qualifies the error",
            "type": "string"
        },
        "details": {
            "description": "Human readable explanation specific to the occurrence of the problem",
            "type": "string"
        },
        "location": {
            "description": "The name of the field that resulted in the error",
            "type": "string"
        },
        "moreInfo": {
            "description": "URI to human readable documentation of the error",
            "type": "object"
        }
    },
    "required": [
        "type",
        "code"
    ]
}

fatal

serverUnavailable

The request failed due to an internal error

Definitions

type
- Invalid - Request did not confirm to the specification and was unprocessed and rejected. Please fix the value and try again
- enum : error, warn, invalid, fatal
- type : string
code
- Error code which qualifies the error
- type : string
details
- Human readable explanation specific to the occurrence of the problem
- type : string
location
- The name of the field that resulted in the error
- type : string
moreInfo
- URI to human readable documentation of the error
- type : object
required
- type
- code

Response Schema for post /v1/in/customers/identity/kyc

{
    "properties": {
        "type": {
            "description": "Invalid - Request did not confirm to the specification and was unprocessed and rejected. Please fix the value and try again",
            "enum": [
                "error",
                "warn",
                "invalid",
                "fatal"
            ],
            "type": "string"
        },
        "code": {
            "description": "Error code which qualifies the error",
            "type": "string"
        },
        "details": {
            "description": "Human readable explanation specific to the occurrence of the problem",
            "type": "string"
        },
        "location": {
            "description": "The name of the field that resulted in the error",
            "type": "string"
        },
        "moreInfo": {
            "description": "URI to human readable documentation of the error",
            "type": "object"
        }
    },
    "required": [
        "type",
        "code"
    ]
}

Retrieve Customer Personal Details from Partner

get /partner/v1/customers/profiles

Description

This API is used to retrieve customer details including personal particulars, address, phone number and email details from the partner's site.

Swagger

Header Parameters

Authorization

string required

The most recent Authorization token. This will have the format Bearer + {space} + {accessToken}. Example: Bearer KGNsaWVudF9pZDpjbGllbnRfc2VjcmV0KQ==.

uuid

string required

128 bit UUID that you generate for every request

string required

Content-Type that are acceptable for the response

client_id

string required

Client ID generated during application registration.

clientDetails

string Optional

Query Parameters

addressType

string Optional

Type of the address. This is a reference data field. Please use /v1/utilities/referenceData/{addressType} resource to get valid value of this field with description.

cURL
Ruby
Python
PHP
Java
Node
Go
Swift

Example Request

Responses

Successful operation.

Definitions

emails
- - emailAddress
    - Updated email address of the customer
    - type : string
  - preferredEmailFlag
    - Flag to indicate the preferred email
    - type : boolean
  - emailKey
    - Unique identifier of the email address
    - type : integer
customerType
- Type of the customer. This is applicable only for Individual customers.This is a reference data field. Please use /v1/apac/utilities/referenceData/{customerType} resource to get valid value of this field with description. You can use customerType as the referenceCode parameter to retrieve the values.
- type : string
customerParticulars
- - names
    - properties : Array
  - prefix
    - The prefix of the customer s name.
    - type : string
  - suffix
    - The suffix of the customer s name.
    - type : string
customerSegment
- Type of the customer. This is applicable only for Individual customers.This is a reference data field. Please use /v1/apac/utilities/referenceData/{customerSegment} resource to get valid value of this field with description. You can use customerSegment as the referenceCode parameter to retrieve the values.
- type : string
partnerCustomerSegment
- Partner customer segment.This is a reference data field. Please use /v1/apac/utilities/referenceData/{partnerCustomerSegment} resource to get possible value of this field with description.
- type : string
addressList
- - addressKey
    - Unique identifier of the address and it is mandatory in update customer address details
    - type : integer
  - city
    - City
    - type : string
  - addressType
    - Type of the address. This is a reference data field. Please use /utilities/referenceData/{addressType} resource to get valid values of this field with descriptions.
    - type : string
  - postalCode
    - Postal code the mailing address
    - type : string
  - addressline3
    - Address line3 of the mailing address
    - type : string
  - addressline2
    - Address line2 of the mailing address
    - type : string
  - addressline1
    - Address line1 of the mailing address
    - type : string
  - state
    - State. This is a reference data field. Please use /v1/apac/utilities/referenceData/{addressState} resource to get valid value of this field with description.
    - type : string
  - countryName
    - Country Name.This is a reference data field. Please use /v1/apac/utilities/referenceData/{countryName} resource to get valid value of this field with description.
    - type : string
  - addressline4
    - Address line3 of the mailing address
    - type : string
phones
- - phoneType
    - The type of phone.This is a reference data field. Please use /utilities/referenceData/{phoneType} resource to get valid values of this field with descriptions
    - type : string
  - areaCode
    - Area code of telephone number
    - type : string
  - extension
    - Extension of telephone number
    - type : string
  - phoneKey
    - Unique identifier of the phone number
    - type : integer
  - phoneNumber
    - The phone number of a customer
    - type : string
  - phoneCountryCode
    - Country calling code. This is a reference data field. Please use /utilities/referenceData/{phoneCountryCode} resource to get valid values of this field with descriptions
    - type : string

Example Response for get /partner/v1/customers/profiles

Type	Code	Details
invalid	invalidRequest	Missing or invalid parameters

Definitions

type
- Invalid - Request did not confirm to the specification and was unprocessed and rejected. Please fix the value and try again
- enum : error, warn, invalid, fatal
- type : string
code
- Error code which qualifies the error
- type : string
details
- Human readable explanation specific to the occurrence of the problem
- type : string
location
- The name of the field that resulted in the error
- type : string
moreInfo
- URI to human readable documentation of the error
- type : object
required
- type
- code

Response Schema for get /partner/v1/customers/profiles

{
    "properties": {
        "type": {
            "description": "Invalid - Request did not confirm to the specification and was unprocessed and rejected. Please fix the value and try again",
            "enum": [
                "error",
                "warn",
                "invalid",
                "fatal"
            ],
            "type": "string"
        },
        "code": {
            "description": "Error code which qualifies the error",
            "type": "string"
        },
        "details": {
            "description": "Human readable explanation specific to the occurrence of the problem",
            "type": "string"
        },
        "location": {
            "description": "The name of the field that resulted in the error",
            "type": "string"
        },
        "moreInfo": {
            "description": "URI to human readable documentation of the error",
            "type": "object"
        }
    },
    "required": [
        "type",
        "code"
    ]
}

error

unAuthorized

Authorization credentials are missing or invalid

Definitions

type
- Invalid - Request did not confirm to the specification and was unprocessed and rejected. Please fix the value and try again
- enum : error, warn, invalid, fatal
- type : string
code
- Error code which qualifies the error
- type : string
details
- Human readable explanation specific to the occurrence of the problem
- type : string
location
- The name of the field that resulted in the error
- type : string
moreInfo
- URI to human readable documentation of the error
- type : object
required
- type
- code

Response Schema for get /partner/v1/customers/profiles

{
    "properties": {
        "type": {
            "description": "Invalid - Request did not confirm to the specification and was unprocessed and rejected. Please fix the value and try again",
            "enum": [
                "error",
                "warn",
                "invalid",
                "fatal"
            ],
            "type": "string"
        },
        "code": {
            "description": "Error code which qualifies the error",
            "type": "string"
        },
        "details": {
            "description": "Human readable explanation specific to the occurrence of the problem",
            "type": "string"
        },
        "location": {
            "description": "The name of the field that resulted in the error",
            "type": "string"
        },
        "moreInfo": {
            "description": "URI to human readable documentation of the error",
            "type": "object"
        }
    },
    "required": [
        "type",
        "code"
    ]
}

error

accessNotConfigured

Access is not configured for this resource

Definitions

type
- Invalid - Request did not confirm to the specification and was unprocessed and rejected. Please fix the value and try again
- enum : error, warn, invalid, fatal
- type : string
code
- Error code which qualifies the error
- type : string
details
- Human readable explanation specific to the occurrence of the problem
- type : string
location
- The name of the field that resulted in the error
- type : string
moreInfo
- URI to human readable documentation of the error
- type : object
required
- type
- code

Response Schema for get /partner/v1/customers/profiles

{
    "properties": {
        "type": {
            "description": "Invalid - Request did not confirm to the specification and was unprocessed and rejected. Please fix the value and try again",
            "enum": [
                "error",
                "warn",
                "invalid",
                "fatal"
            ],
            "type": "string"
        },
        "code": {
            "description": "Error code which qualifies the error",
            "type": "string"
        },
        "details": {
            "description": "Human readable explanation specific to the occurrence of the problem",
            "type": "string"
        },
        "location": {
            "description": "The name of the field that resulted in the error",
            "type": "string"
        },
        "moreInfo": {
            "description": "URI to human readable documentation of the error",
            "type": "object"
        }
    },
    "required": [
        "type",
        "code"
    ]
}

error

resourceNotFound

Empty resource/resource not found

Definitions

type
- Invalid - Request did not confirm to the specification and was unprocessed and rejected. Please fix the value and try again
- enum : error, warn, invalid, fatal
- type : string
code
- Error code which qualifies the error
- type : string
details
- Human readable explanation specific to the occurrence of the problem
- type : string
location
- The name of the field that resulted in the error
- type : string
moreInfo
- URI to human readable documentation of the error
- type : object
required
- type
- code

Response Schema for get /partner/v1/customers/profiles

{
    "properties": {
        "type": {
            "description": "Invalid - Request did not confirm to the specification and was unprocessed and rejected. Please fix the value and try again",
            "enum": [
                "error",
                "warn",
                "invalid",
                "fatal"
            ],
            "type": "string"
        },
        "code": {
            "description": "Error code which qualifies the error",
            "type": "string"
        },
        "details": {
            "description": "Human readable explanation specific to the occurrence of the problem",
            "type": "string"
        },
        "location": {
            "description": "The name of the field that resulted in the error",
            "type": "string"
        },
        "moreInfo": {
            "description": "URI to human readable documentation of the error",
            "type": "object"
        }
    },
    "required": [
        "type",
        "code"
    ]
}

fatal

serverUnavailable

The request failed due to an internal error

Definitions

type
- Invalid - Request did not confirm to the specification and was unprocessed and rejected. Please fix the value and try again
- enum : error, warn, invalid, fatal
- type : string
code
- Error code which qualifies the error
- type : string
details
- Human readable explanation specific to the occurrence of the problem
- type : string
location
- The name of the field that resulted in the error
- type : string
moreInfo
- URI to human readable documentation of the error
- type : object
required
- type
- code

Response Schema for get /partner/v1/customers/profiles

{
    "properties": {
        "type": {
            "description": "Invalid - Request did not confirm to the specification and was unprocessed and rejected. Please fix the value and try again",
            "enum": [
                "error",
                "warn",
                "invalid",
                "fatal"
            ],
            "type": "string"
        },
        "code": {
            "description": "Error code which qualifies the error",
            "type": "string"
        },
        "details": {
            "description": "Human readable explanation specific to the occurrence of the problem",
            "type": "string"
        },
        "location": {
            "description": "The name of the field that resulted in the error",
            "type": "string"
        },
        "moreInfo": {
            "description": "URI to human readable documentation of the error",
            "type": "object"
        }
    },
    "required": [
        "type",
        "code"
    ]
}

Retrieve Offer Details

get /v1/sales/customers/offers/details

Description

This API allows to retrieve the details for an offer.

Swagger

Header Parameters

Authorization

string required

The most recent Authorization token. This will have the format Bearer + {space} + {accessToken}. Example: Bearer KGNsaWVudF9pZDpjbGllbnRfc2VjcmV0KQ==.

uuid

string required

128 bit random UUID generated uniquely for every request.

string required

Content-Type that are acceptable for the response.

client_id

string required

Client ID generated during application registration.

clientDetails

string Optional

Query Parameters

campaignId

string Optional

Unique identifier for a specific campaign being offered to the channel

waveId

string Optional

Unique identifier for the promotion under specific campaign being offered to the channel

accountId

string Optional

The account number in encrypted format

cardId

string Optional

Unique Id of the card in encrypted format

offerId

string Optional

Unique offer ID associated with the offer

offerSegmentCategory

string Optional

This field is used to Classify the Offers into appropriate segments to allow usage managers to target offers to a specific group of customers. This is a reference data field. Please use /v1/utilities/referenceData/{offerSegmentCategory} resource to get valid value of this field with description

virtualOfferFlag

boolean Optional

Indicates if offer is virtual

productCode

string Optional

A unique code that identifies the product

cURL
Ruby
Python
PHP
Java
Node
Go
Swift

Example Request

Responses

Successful operation.

Definitions

offerType
- Type of offer. This is a reference data field. Please use /v1/utilities/referenceData/{offerType} resource to get valid value of this field with description
- type : string
campaignId
- Unique identifier for a specific campaign being offered to the channel
- type : string
waveId
- Unique identifier for the promotion under specific campaign being offered to the channel
- type : string
waveDescription
- Description of the benefits of taking the product under the given offer
- type : string
offerStartDate
- Start Date of the promotion in ISO 8601 date format YYYY-MM-DD
- type : string
- format : date
offerExpiryDate
- Expiry Date of the promotion in ISO 8601 date format YYYY-MM-DD
- type : string
- format : date
offerPriority
- Preferred sequence in which offers are to be sorted in the event that the bank wants to prioritize or focus on the offers of a specific campaign
- type : string
offerProductCode
- A unique code that identifies the offered product to applicant
- type : string
offerProductDescription
- Description of the Product for the offer
- type : string
yearsWithCitiRelationship
- - languageCode
    - Preferred language of communication
    - type : string
  - relationshipWithCitiInYears
    - Customer relationship in years with Citi
    - type : integer
    - format : int32
  - lastUpgradedCustomerSegment
    - Customer segment decides each applicants interest rate, Different customer target will be subjected to different interest rate. This is a reference data field. Please use /v1/utilities/referenceData/{customerSegment} resource to get possible value of this field with description
    - type : string
  - returnsNetSavingsAmount
    - Net saving money and amount is rounded off to nearest lower 10s
    - type : integer
    - format : int32
  - returnsNewInvestmentAmount
    - New investment brought in and amount is rounded off to nearest lower 10s.
    - type : integer
    - format : int32
  - returnsDividendsEarnedAmount
    - Dividends earned and amount is rounded off to nearest lower 10s.
    - type : integer
    - format : int32
  - returnsTotalGainAmount
    - Total realised and unrealised gain including fees.Amount is rounded off to nearest lower 10s
    - type : integer
    - format : int32
  - currentCustomerSegment
    - Customer segment decides each applicants interest rate, Different customer target will be subjected to different interest rate. This is a reference data field. Please use /v1utilities/referenceData/{customerSegment} resource to get possible value of this field with description
    - type : string
  - goalSubmissionFlag
    - If customer has previosuly submitted the Goals for next financial year
    - type : boolean
ecdOffer
- - productSecurityCode
    - This field is used to stored Product security code if any for ECD (Electronic Certificate of Deposit) offers
    - type : string
offerStatus
- Offer Status. This is a reference data field. Please use /v1/utilities/referenceData/{offerStatus} resource to get possible value of this field with description
- type : string
merchantRecommendationOffer
- - offerSegmentCategory
    - This field is used to Classify the Offers into appropriate segments to allow usage managers to target offers to a specific group of customers. This is a reference data field. Please use /v1/utilities/referenceData/{offerSegmentCategory} resource to get valid value of this field with description
    - type : string
  - offerSegmentScore
    - This is a score that is determined by Offer system in the range of 1 to 100.
    - type : string
  - offerRank
    - The rank is determined/derived by Offer system. It is derived based on the segment and ranking.
    - type : string
  - offerMode
    - Each offer is classified as either Geo, Non-Geo or Batch. This is a reference data field. Please use /v1/utilities/referenceData/{offerMode} resource to get valid value of this field with description.
    - type : string
  - localOverseasIndicator
    - This is to indicate to specify whether a given offer is local or overseas. This is a reference data field. Please use /v1/utilities/referenceData/{localOverseasIndicator} resource to get valid value of this field with description.
    - type : string
  - merchantCatagory
    - Each of the Merchants in the repository is tagged to a category. Please use /v1/utilities/referenceData/{merchantCategory} resource to get valid value of this field with description.
    - type : string
customerActionGroup
- - customerAction
    - This is to indicate to specify whether a given offer is liked or disliked This is a reference data field. Please use /v1/utilities/referenceData/{customerAction} resource to get valid value of this field with description.
    - type : string
  - customerActionDateTime
    - Customer action date-time in ISO 8601 date format YYYY-MM-DDTHH:MM:SS
    - type : string
templateFields
- - templateFieldKey
    - Template variable key
    - type : string
  - templateFieldValue
    - Template variable value
    - type : string
easyPaymentPlan
- - promotionId
    - Unique identifier for a specific promotion being offered for a specific campaign/offer
    - type : string
  - merchantOrganizationNumber
    - Merchant organization number for the perticular merchant
    - type : string
  - merchantNumber
    - Unique identifier associated with the merchant
    - type : string
  - offerIndicator
    - This is to indicate if the offer is rate/fee/hybrid based. This is a reference data field. Please use /v1/utilities/referenceData/{offerIndicator} resource to get valid value of this field with description
    - type : string
  - creditLimitPercentage
    - percentages of that perticular credit limit
    - type : number
    - format : double
  - eppMinimumEligibleAmount
    - minimum Amount which eligible for that customer
    - type : number
    - format : double
  - eppMaximumEligibleAmount
    - maximum Amount which eligible for that customer
    - type : number
    - format : double
loanOverPhoneOffer
- - promotionId
    - Unique identifier for a specific promotion being offered for a specific campaign/offer
    - type : string
  - offerIndicator
    - This is to indicate if the offer is rate/fee/hybrid based. This is a reference data field. Please use /v1/utilities/referenceData/{offerIndicator} resource to get valid value of this field with description
    - type : string
  - creditLimitPercantage
    - percentages of that perticular credit limit
    - type : number
    - format : double
  - monthlyFlatRate
    - This field is used to specify maximum monthly flat rate
    - type : number
    - format : double
  - lopMinimumEligibleAmount
    - Minimum eligible amount for which loan over phone can be booked
    - type : number
    - format : double
  - lopMaximumEligibleAmount
    - Maximum eligible amount for which loan over phone Plan can be booked.
    - type : number
    - format : double
  - lopIndicator
    - This field is used to indicate whether it is LOP/Advance LOP. This is a reference data field. Please use /v1/utilities/referenceData/{lopIndicator} resource to get valid value of this field with description.
    - type : number
    - format : double
balanceTransferOffer
- - promotionId
    - Unique identifier for a specific promotion being offered for a specific campaign/offer
    - type : string
  - offerIndicator
    - This is to indicate if the offer is rate/fee/hybrid based. This is a reference data field. Please use /v1/utilities/referenceData/{offerIndicator} resource to get valid value of this field with description
    - type : string
  - eligibleLoanAmount
    - Recommended loan amount
    - type : number
    - format : double
  - creditLimitPercantage
    - percentages of that perticular credit limit
    - type : number
    - format : double
  - btMinimumEligibleAmount
    - Minimum eligible amount for which balance transfer can be booked.
    - type : number
    - format : double
  - btMaximumEligibleAmount
    - Maximum eligible amount for which balance transfer can be booked.
    - type : number
    - format : double
genericOffer
customerSegmentChangeOffer
- - currentCustomerSegment
    - Type of the customer. This is applicable only for Individual customers.This is a reference data field. Please use /v1/utilities/referenceData/{customerSegment} resource to get valid value of this field with description.
    - type : string
  - previousCustomerSegment
    - Type of the customer. This is applicable only for Individual customers.This is a reference data field. Please use /v1/utilities/referenceData/{customerSegment} resource to get valid value of this field with description.
    - type : string
  - customerSegmentChangeDate
    - Customer segment change date in ISO 8601 date format YYYY-MM-DD
    - type : string
    - format : date
  - targetTrbDifferentAmount
    - Difference in amount in current TRB(Total Releationship Balance amount) to next segment threshold amount
    - type : number
    - format : double
  - segmentChangeOfferCode
    - Based on customers current segment, customer is categoried in scenarios based on his/her current TRB(Total Relationship Balance amount) and duration for maintaing that balance. Based on this scenario customer will be given different offer
    - type : string

Example Response for get /v1/sales/customers/offers/details

No content

This operation returns no content.

Type	Code	Details
invalid	invalidRequest	Missing or invalid Parameters

Definitions

type
- Invalid - Request did not confirm to the specification and was unprocessed and rejected. Please fix the value and try again
- enum : error, warn, invalid, fatal
- type : string
code
- Error code which qualifies the error
- type : string
details
- Human readable explanation specific to the occurrence of the problem
- type : string
location
- The name of the field that resulted in the error
- type : string
moreInfo
- URI to human readable documentation of the error
- type : object
required
- type
- code

Response Schema for get /v1/sales/customers/offers/details

{
    "properties": {
        "type": {
            "description": "Invalid - Request did not confirm to the specification and was unprocessed and rejected. Please fix the value and try again",
            "enum": [
                "error",
                "warn",
                "invalid",
                "fatal"
            ],
            "type": "string"
        },
        "code": {
            "description": "Error code which qualifies the error",
            "type": "string"
        },
        "details": {
            "description": "Human readable explanation specific to the occurrence of the problem",
            "type": "string"
        },
        "location": {
            "description": "The name of the field that resulted in the error",
            "type": "string"
        },
        "moreInfo": {
            "description": "URI to human readable documentation of the error",
            "type": "object"
        }
    },
    "required": [
        "type",
        "code"
    ]
}

Type	Code	Details
error	unAuthorized	Authorization credentials are missing or invalid

Definitions

type
- Invalid - Request did not confirm to the specification and was unprocessed and rejected. Please fix the value and try again
- enum : error, warn, invalid, fatal
- type : string
code
- Error code which qualifies the error
- type : string
details
- Human readable explanation specific to the occurrence of the problem
- type : string
location
- The name of the field that resulted in the error
- type : string
moreInfo
- URI to human readable documentation of the error
- type : object
required
- type
- code

Response Schema for get /v1/sales/customers/offers/details

{
    "properties": {
        "type": {
            "description": "Invalid - Request did not confirm to the specification and was unprocessed and rejected. Please fix the value and try again",
            "enum": [
                "error",
                "warn",
                "invalid",
                "fatal"
            ],
            "type": "string"
        },
        "code": {
            "description": "Error code which qualifies the error",
            "type": "string"
        },
        "details": {
            "description": "Human readable explanation specific to the occurrence of the problem",
            "type": "string"
        },
        "location": {
            "description": "The name of the field that resulted in the error",
            "type": "string"
        },
        "moreInfo": {
            "description": "URI to human readable documentation of the error",
            "type": "object"
        }
    },
    "required": [
        "type",
        "code"
    ]
}

Type	Code	Details
error	accessNotConfigured	The request operation is not configured to access this resource

Definitions

type
- Invalid - Request did not confirm to the specification and was unprocessed and rejected. Please fix the value and try again
- enum : error, warn, invalid, fatal
- type : string
code
- Error code which qualifies the error
- type : string
details
- Human readable explanation specific to the occurrence of the problem
- type : string
location
- The name of the field that resulted in the error
- type : string
moreInfo
- URI to human readable documentation of the error
- type : object
required
- type
- code

Response Schema for get /v1/sales/customers/offers/details

{
    "properties": {
        "type": {
            "description": "Invalid - Request did not confirm to the specification and was unprocessed and rejected. Please fix the value and try again",
            "enum": [
                "error",
                "warn",
                "invalid",
                "fatal"
            ],
            "type": "string"
        },
        "code": {
            "description": "Error code which qualifies the error",
            "type": "string"
        },
        "details": {
            "description": "Human readable explanation specific to the occurrence of the problem",
            "type": "string"
        },
        "location": {
            "description": "The name of the field that resulted in the error",
            "type": "string"
        },
        "moreInfo": {
            "description": "URI to human readable documentation of the error",
            "type": "object"
        }
    },
    "required": [
        "type",
        "code"
    ]
}

Type	Code	Details
fatal	serverUnavailable	The request failed due to an internal error

Definitions

type
- Invalid - Request did not confirm to the specification and was unprocessed and rejected. Please fix the value and try again
- enum : error, warn, invalid, fatal
- type : string
code
- Error code which qualifies the error
- type : string
details
- Human readable explanation specific to the occurrence of the problem
- type : string
location
- The name of the field that resulted in the error
- type : string
moreInfo
- URI to human readable documentation of the error
- type : object
required
- type
- code

Response Schema for get /v1/sales/customers/offers/details

{
    "properties": {
        "type": {
            "description": "Invalid - Request did not confirm to the specification and was unprocessed and rejected. Please fix the value and try again",
            "enum": [
                "error",
                "warn",
                "invalid",
                "fatal"
            ],
            "type": "string"
        },
        "code": {
            "description": "Error code which qualifies the error",
            "type": "string"
        },
        "details": {
            "description": "Human readable explanation specific to the occurrence of the problem",
            "type": "string"
        },
        "location": {
            "description": "The name of the field that resulted in the error",
            "type": "string"
        },
        "moreInfo": {
            "description": "URI to human readable documentation of the error",
            "type": "object"
        }
    },
    "required": [
        "type",
        "code"
    ]
}