--- swagger: "2.0" info: title: Customers description: The Customers API allows you to retrieve basic Citi customer information like name, mailing address, email address and phone numbers. version: 1.0.0n x-ibm-name: customers_100n name: "" schemes: - https basePath: /api produces: - application/json paths: /v1/customers/profiles: get: summary: Retrieve Customer Personal Details description: This API is used to retrieve customer details including personal particulars, address, phone number and email details. responses: 200: schema: $ref: '#/definitions/CustomerProfileResponse' description: Successful operation. 400: schema: $ref: '#/definitions/ErrorResponse' description:
TypeCodeDetails
invalidinvalidRequestMissing or invalid parameters
401: schema: $ref: '#/definitions/ErrorResponse' description:
errorunAuthorizedAuthorization credentials are missing or invalid
403: schema: $ref: '#/definitions/ErrorResponse' description:
erroraccessNotConfiguredAccess is not configured for this resource
404: schema: $ref: '#/definitions/ErrorResponse' description:
errorresourceNotFoundEmpty resource/resource not found
500: schema: $ref: '#/definitions/ErrorResponse' description:
fatalserverUnavailableThe request failed due to an internal error
parameters: - in: header name: Authorization description: 'The most recent Authorization token. This will have the format Bearer + {space} + {accessToken}. Example: Bearer KGNsaWVudF9pZDpjbGllbnRfc2VjcmV0KQ==.' type: string required: true - in: header name: uuid description: 128 bit UUID that you generate for every request type: string required: true - in: header name: Accept description: Content-Type that are acceptable for the response type: string required: true - in: header name: client_id description: Client ID generated during application registration. type: string required: true put: summary: Update Customer Personal Details description: This API is used to update customer details including address, phone number and email details. tags: - Customers parameters: - name: Authorization in: header description: 'The most recent Authorization token. This will have the format Bearer + {space} + {accessToken}. Example: Bearer KGNsaWVudF9pZDpjbGllbnRfc2VjcmV0KQ==' type: string required: true - name: uuid in: header description: 128 bit random UUID generated uniquely for every request. type: string required: true - name: Accept in: header description: Content-Type that are acceptable for the response. type: string required: true - name: client_id in: header description: Client ID generated during application registration. required: true type: string - name: Content-Type in: header description: application/json required: true type: string - name: clientDetails in: header description: 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 type: string required: false - name: CustomerProfileUpdateRequest in: body required: true schema: $ref: '#/definitions/CustomerProfileUpdateRequest' responses: 200: description: Successful operation. schema: $ref: '#/definitions/CustomerProfileUpdateResponse' 206: description: This is applicable for scenarios when one or more requests are failed. schema: $ref: '#/definitions/CustomerProfileUpdateResponse' 400: description:
TypeCodeDetails
invalidinvalidRequestMissing or invalid parameters
errortransactionDeniedTransaction Denied
errorcustomerProfileUpdateFailureCustomer Profile Update Failure
schema: $ref: '#/definitions/ErrorResponse' 401: description:
errorunAuthorizedAuthorization credentials are missing or invalid
schema: $ref: '#/definitions/ErrorResponse' 403: description:
erroraccessNotConfiguredAccess is not configured for this resource
errormfaRequiredMFA is required
schema: $ref: '#/definitions/ErrorResponse' 500: description:
fatalserverUnavailableThe request failed due to an internal error
schema: $ref: '#/definitions/ErrorResponse' /v1/customers/profiles/basic: get: summary: Retrieve Customer Particulars description: This API is used to retrieve customer particulars including name, surname, prefix and suffix. responses: 200: schema: $ref: '#/definitions/CustomerParticularResponse' description: Successful operation. 400: schema: $ref: '#/definitions/ErrorResponse' description:
TypeCodeDetails
invalidinvalidRequestMissing or invalid parameters
401: schema: $ref: '#/definitions/ErrorResponse' description:
errorunAuthorizedAuthorization credential is missing or invalid
403: schema: $ref: '#/definitions/ErrorResponse' description:
erroraccessNotConfiguredAccess is not configured for this resource
404: schema: $ref: '#/definitions/ErrorResponse' description:
errorresourceNotFoundEmpty resource/resource not found
500: schema: $ref: '#/definitions/ErrorResponse' description:
fatalserverUnavailableThe request failed due to an internal error
parameters: - in: header name: Authorization description: 'The most recent Authorization token. This will have the format Bearer + {space} + {accessToken}. Example: Bearer KGNsaWVudF9pZDpjbGllbnRfc2VjcmV0KQ==.' type: string required: true - in: header name: uuid description: 128 bit random UUID generated uniquely for every request. type: string required: true - in: header name: Accept description: Content-Type that are acceptable for the response. type: string required: true - in: header name: client_id description: Client ID generated during application registration. type: string required: true /v1/customers/profiles/addresses: get: summary: Retrieve Customer Address Details description: This API is used to retrieve customer home address details. responses: 200: schema: $ref: '#/definitions/CustomerAddressResponse' description: Successful operation. 400: schema: $ref: '#/definitions/ErrorResponse' description:
TypeCodeDetails
invalidinvalidRequestMissing or invalid parameters
401: schema: $ref: '#/definitions/ErrorResponse' description:
errorunAuthorizedAuthorization credentials are missing or invalid
403: schema: $ref: '#/definitions/ErrorResponse' description:
erroraccessNotConfiguredAccess is not configured for this resource
404: schema: $ref: '#/definitions/ErrorResponse' description:
errorresourceNotFoundEmpty resource/resource not found
500: schema: $ref: '#/definitions/ErrorResponse' description:
fatalserverUnavailableThe request failed due to an internal error
parameters: - in: header name: Authorization description: 'The most recent Authorization token. This will have the format Bearer + {space} + {accessToken}. Example: Bearer KGNsaWVudF9pZDpjbGllbnRfc2VjcmV0KQ==.' type: string required: true - in: header name: uuid description: 128 bit UUID that you generate for every request type: string required: true - in: header name: Accept description: Content-Type that are acceptable for the response type: string required: true - in: header name: client_id description: Client ID generated during application registration. type: string required: true post: summary: Update Customer Address Details description: This API is used to update customer address details and it also allows to add in specific case. tags: - Customer Service parameters: - name: Authorization in: header description: 'The most recent Authorization token. This will have the format Bearer + {space} + {accessToken}. Example: Bearer KGNsaWVudF9pZDpjbGllbnRfc2VjcmV0KQ==.' type: string required: true - name: uuid in: header description: 128 bit random UUID generated uniquely for every request. type: string required: true - name: Accept in: header description: Content-Type that are acceptable for the response. type: string required: true - name: client_id in: header description: Client ID generated during application registration. required: true type: string - name: Content-Type in: header description: application/json required: true type: string - name: clientDetails in: header description: 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 type: string required: false - name: CustomerAddressUpdateRequest required: true description: Request in: body schema: $ref: '#/definitions/CustomerAddressUpdateRequest' responses: 200: description: Successful operation. 400: description:
TypeCodeDetails
invalidinvalidRequestMissing or invalid Parameters
errorexceededMaximumAllowedAddressesExceeded maximum allowed addresses
erroraddressAdditionFailedAddition of address is not supported
schema: $ref: '#/definitions/ErrorResponse' 401: description:
errorunAuthorizedAuthorization credentials are missing or invalid
schema: $ref: '#/definitions/ErrorResponse' 403: description:
erroraccessNotConfiguredThe request operation is not configured to access this resource
errormfaRequiredMFA is required
errortransactionDeniedTransaction Denied
errorphoneNumberInCoolOffPeriodMobile number is in cool off period
schema: $ref: '#/definitions/ErrorResponse' 500: description:
fatalserverUnavailableThe request failed due to an internal error
schema: $ref: '#/definitions/ErrorResponse' /v1/customers/profiles/addresses/confirmation: post: summary: Confirm customer's primary address description: Confirms the customer’s CITI address update. It should be called after the successful multi factor authentication of the customer. tags: - Customer Service parameters: - name: Authorization in: header description: 'The most recent Authorization token. This will have the format Bearer + {space} + {accessToken}. Example: Bearer KGNsaWVudF9pZDpjbGllbnRfc2VjcmV0KQ==' type: string required: true - name: uuid in: header description: 128 bit random UUID generated uniquely for every request. type: string required: true - name: Accept in: header description: Content-Type that are acceptable for the response. type: string required: true - name: client_id in: header description: Client ID generated during application registration. required: true type: string - name: Content-Type in: header description: application/json required: true type: string - name: clientDetails in: header description: 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 type: string required: false - name: CustomerAddressUpdateConfirmationRequest in: body required: true schema: $ref: '#/definitions/CustomerAddressUpdateConfirmationRequest' responses: 200: description: Successful operation. 400: description:
TypeCodeDetails
invalidinvalidRequestMissing or invalid parameters
errorinvalidControlFlowIdControl Flow Id is invalid
schema: $ref: '#/definitions/ErrorResponse' 401: description:
errorunAuthorizedAuthorization credentials are missing or invalid
schema: $ref: '#/definitions/ErrorResponse' 403: description:
erroraccessNotConfiguredAccess is not configured for this resource
errormfaRequiredMFA is required
errortransactionDeniedTransaction Denied
schema: $ref: '#/definitions/ErrorResponse' 500: description:
fatalserverUnavailableThe request failed due to an internal error
schema: $ref: '#/definitions/ErrorResponse' /v1/customers/profiles/emails: get: summary: Retrieve Customer Email description: This API is used to retrieve customer email address details. responses: 200: schema: $ref: '#/definitions/CustomerEmailResponse' description: Successful operation. 400: schema: $ref: '#/definitions/ErrorResponse' description:
TypeCodeDetails
invalidinvalidRequestMissing or invalid parameters
401: schema: $ref: '#/definitions/ErrorResponse' description:
errorunAuthorizedAuthorization credential is missing or invalid
403: schema: $ref: '#/definitions/ErrorResponse' description:
erroraccessNotConfiguredAccess is not configured for this resource
404: schema: $ref: '#/definitions/ErrorResponse' description:
errorresourceNotFoundEmpty resource/resource not found
500: schema: $ref: '#/definitions/ErrorResponse' description:
fatalserverUnavailableThe request failed due to an internal error
parameters: - in: header name: Authorization description: 'The most recent Authorization token. This will have the format Bearer + {space} + {accessToken}. Example: Bearer KGNsaWVudF9pZDpjbGllbnRfc2VjcmV0KQ==.' type: string required: true - in: header name: uuid description: 128 bit random UUID generated uniquely for every request. type: string required: true - in: header name: Accept description: Content-Type that are acceptable for the response. type: string required: true - in: header name: client_id description: Client ID generated during application registration. type: string required: true put: summary: Update Customer Email description: This API is used to update customer's email address. tags: - Customer Service parameters: - name: Authorization in: header description: 'The most recent Authorization token. This will have the format Bearer + {space} + {accessToken}. Example: Bearer KGNsaWVudF9pZDpjbGllbnRfc2VjcmV0KQ==.' type: string required: true - name: uuid in: header description: 128 bit random UUID generated uniquely for every request. type: string required: true - name: Accept in: header description: Content-Type that are acceptable for the response. type: string required: true - name: client_id in: header description: Client ID generated during application registration. required: true type: string - name: Content-Type in: header description: application/json required: true type: string - name: clientDetails in: header description: 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 type: string required: false - name: CustomerEmailUpdateRequest required: true in: body schema: $ref: '#/definitions/CustomerEmailUpdateRequest' responses: 200: description: Successful operation. 400: description:
TypeCodeDetails
invalidinvalidRequestMissing or invalid Parameters
errorexceededMaximumAllowedEmailsExceeded maximum allowed emails
errorphoneNumberInCoolOffPeriodMobile number is in cool off period
schema: $ref: '#/definitions/ErrorResponse' 401: description:
errorunAuthorizedAuthorization credentials are missing or invalid
schema: $ref: '#/definitions/ErrorResponse' 403: description:
erroraccessNotConfiguredThe request operation is not configured to access this resource
errormfaRequiredMFA is required
schema: $ref: '#/definitions/ErrorResponse' 404: description:
errorresourceNotFoundEmpty resource/resource not found
schema: $ref: '#/definitions/ErrorResponse' 500: description:
fatalserverUnavailableThe request failed due to an internal error
schema: $ref: '#/definitions/ErrorResponse' /v1/customers/profiles/emails/confirmation: post: summary: Confirm Customer Email Update description: This API is required to confirm the customer’s email address updates. This is triggered after the successful multi factor authentication. tags: - Customer Service parameters: - name: Authorization in: header description: 'The most recent Authorization token. This will have the format Bearer + {space} + {accessToken}. Example: Bearer KGNsaWVudF9pZDpjbGllbnRfc2VjcmV0KQ==' type: string required: true - name: uuid in: header description: 128 bit random UUID generated uniquely for every request. type: string required: true - name: Accept in: header description: Content-Type that are acceptable for the response. type: string required: true - name: client_id in: header description: Client ID generated during application registration. required: true type: string - name: Content-Type in: header description: application/json required: true type: string - name: clientDetails in: header description: 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 type: string required: false - name: CustomerEmailUpdateConfirmationRequest in: body required: true schema: $ref: '#/definitions/CustomerEmailUpdateConfirmationRequest' responses: 200: description: Successful operation. 400: description:
TypeCodeDetails
invalidinvalidRequestMissing or invalid parameters
errorinvalidControlFlowIdControl Flow Id is invalid
schema: $ref: '#/definitions/ErrorResponse' 401: description:
errorunAuthorizedAuthorization credentials are missing or invalid
schema: $ref: '#/definitions/ErrorResponse' 403: description:
erroraccessNotConfiguredAccess is not configured for this resource
schema: $ref: '#/definitions/ErrorResponse' 500: description:
fatalserverUnavailableThe request failed due to an internal error
schema: $ref: '#/definitions/ErrorResponse' /v1/customers/profiles/phoneNumbers: get: summary: Retrieve Customer Phone Number description: This API is used to retrieve customer's home, office and mobile phone numbers. responses: 200: schema: $ref: '#/definitions/CustomerPhoneResponse' description: Successful operation. 400: schema: $ref: '#/definitions/ErrorResponse' description:
TypeCodeDetails
invalidinvalidRequestMissing or invalid parameters
401: schema: $ref: '#/definitions/ErrorResponse' description:
errorunAuthorizedAuthorization credential is missing or invalid
403: schema: $ref: '#/definitions/ErrorResponse' description:
erroraccessNotConfiguredAccess is not configured for this resource
404: schema: $ref: '#/definitions/ErrorResponse' description:
errorresourceNotFoundEmpty resource/resource not found
500: schema: $ref: '#/definitions/ErrorResponse' description:
fatalserverUnavailableThe request failed due to an internal error
parameters: - in: header name: Authorization description: 'The most recent Authorization token. This will have the format Bearer + {space} + {accessToken}. Example: Bearer KGNsaWVudF9pZDpjbGllbnRfc2VjcmV0KQ==.' type: string required: true - in: header name: uuid description: 128 bit random UUID generated uniquely for every request. type: string required: true - in: header name: Accept description: Content-Type that are acceptable for the response. type: string required: true - in: header name: client_id description: Client ID generated during application registration. type: string required: true put: summary: Update Customer Phone Number description: This API is used to update customer's phone numbers which include home, office and mobile. tags: - Customer Service parameters: - name: Authorization in: header description: 'The most recent Authorization token. This will have the format Bearer + {space} + {accessToken}. Example: Bearer KGNsaWVudF9pZDpjbGllbnRfc2VjcmV0KQ==.' type: string required: true - name: uuid in: header description: 128 bit random UUID generated uniquely for every request. type: string required: true - name: Accept in: header description: Content-Type that are acceptable for the response. type: string required: true - name: client_id in: header description: Client ID generated during application registration. required: true type: string - name: Content-Type in: header description: application/json required: true type: string - name: clientDetails in: header description: 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 type: string required: false - name: CustomerPhoneUpdateRequest required: true in: body schema: $ref: '#/definitions/CustomerPhoneUpdateRequest' responses: 200: description: Successful operation. 400: description:
TypeCodeDetails
invalidinvalidRequestMissing or invalid Parameters
errorexceededMaximumAllowedPhonesExceeded maximum allowed phones
errorphoneNumberInCoolOffPeriodMobile number is in cool off period
schema: $ref: '#/definitions/ErrorResponse' 401: description:
errorunAuthorizedAuthorization credentials are missing or invalid
schema: $ref: '#/definitions/ErrorResponse' 403: description:
erroraccessNotConfiguredThe request operation is not configured to access this resource
errormfaRequiredMFA is required
schema: $ref: '#/definitions/ErrorResponse' 404: description:
errorresourceNotFoundEmpty resource/resource not found
schema: $ref: '#/definitions/ErrorResponse' 500: description:
fatalserverUnavailableThe request failed due to an internal error
schema: $ref: '#/definitions/ErrorResponse' /v1/customers/profiles/phoneNumbers/confirmation: post: summary: Confirm Customer Phone Number Update description: This API is required to confirm the customer’s phone number updates. This is triggered after the successful multi factor authentication. tags: - Customer Service parameters: - name: Authorization in: header description: 'The most recent Authorization token. This will have the format Bearer + {space} + {accessToken}. Example: Bearer KGNsaWVudF9pZDpjbGllbnRfc2VjcmV0KQ==' type: string required: true - name: uuid in: header description: 128 bit random UUID generated uniquely for every request. type: string required: true - name: Accept in: header description: Content-Type that are acceptable for the response. type: string required: true - name: client_id in: header description: Client ID generated during application registration. required: true type: string - name: Content-Type in: header description: application/json required: true type: string - name: clientDetails in: header description: 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 type: string required: false - name: CustomerPhoneUpdateConfirmationRequest in: body required: true schema: $ref: '#/definitions/CustomerPhoneUpdateConfirmationRequest' responses: 200: description: Successful operation. 400: description:
TypeCodeDetails
invalidinvalidRequestMissing or invalid parameters
errorinvalidControlFlowIdControl Flow Id is invalid
schema: $ref: '#/definitions/ErrorResponse' 401: description:
errorunAuthorizedAuthorization credentials are missing or invalid
schema: $ref: '#/definitions/ErrorResponse' 403: description:
erroraccessNotConfiguredAccess is not configured for this resource
error
schema: $ref: '#/definitions/ErrorResponse' 500: description:
fatalserverUnavailableThe request failed due to an internal error
schema: $ref: '#/definitions/ErrorResponse' /v1/in/customers/identity/otp: post: summary: Trigger an OTP from UIDAI 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. tags: - Aadhaar parameters: - name: Authorization in: header description: 'The most recent Authorization token. This will have the format Bearer + {space} + {accessToken}. Example: Bearer KGNsaWVudF9pZDpjbGllbnRfc2VjcmV0KQ==.' type: string required: true - name: uuid in: header description: 128 bit random UUID generated uniquely for every request. type: string required: true - name: Accept in: header description: Content-Type that are acceptable for the response. type: string required: true - name: client_id in: header description: Client ID generated during application registration. required: true type: string - name: Content-Type in: header description: application/json required: true type: string - name: clientDetails in: header description: 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 type: string required: false - name: AadhaarOtpRequest in: body description: AadhaarOtpRequest required: true schema: $ref: '#/definitions/AadhaarOtpRequest' responses: 200: description: Successful operation. schema: $ref: '#/definitions/AadhaarOtpResponse' 400: description:
TypeCodeDetails
invalidinvalidRequestMissing or invalid Parameters
schema: $ref: '#/definitions/ErrorResponse' 401: description:
errorunAuthorizedAuthorization credentials are missing or invalid
schema: $ref: '#/definitions/ErrorResponse' 403: description:
erroraccessNotConfiguredThe request operation is not configured to access this resource
schema: $ref: '#/definitions/ErrorResponse' 500: description:
fatalserverUnavailableThe request failed due to an internal error
schema: $ref: '#/definitions/ErrorResponse' /v1/in/customers/identity/kyc: post: summary: Retrieve KYC Information from Aadhaar description: This API is used to check the validity of Aadhaar and to receive KYC information about the Aadhaar holder. tags: - Aadhaar parameters: - name: Authorization in: header description: 'The most recent Authorization token. This will have the format Bearer + {space} + {accessToken}. Example: Bearer KGNsaWVudF9pZDpjbGllbnRfc2VjcmV0KQ==.' type: string required: true - name: uuid in: header description: 128 bit random UUID generated uniquely for every request. type: string required: true - name: Accept in: header description: Content-Type that are acceptable for the response. type: string required: true - name: client_id in: header description: Client ID generated during application registration. required: true type: string - name: Content-Type in: header description: application/json required: true type: string - name: clientDetails in: header description: 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 type: string required: false - name: AadhaarEkycRequest in: body description: AadhaarEkycRequest required: true schema: $ref: '#/definitions/AadhaarEkycRequest' responses: 200: description: Successful operation. schema: $ref: '#/definitions/AadhaarEkycResponse' 400: description:
TypeCodeDetails
invalidinvalidRequestMissing or invalid Parameters
schema: $ref: '#/definitions/ErrorResponse' 401: description:
errorunAuthorizedAuthorization credentials are missing or invalid
schema: $ref: '#/definitions/ErrorResponse' 403: description:
erroraccessNotConfiguredThe request operation is not configured to access this resource
schema: $ref: '#/definitions/ErrorResponse' 500: description:
fatalserverUnavailableThe request failed due to an internal error
schema: $ref: '#/definitions/ErrorResponse' /partner/v1/customers/profiles: get: summary: Retrieve Customer Personal Details from Partner description: This API is used to retrieve customer details including personal particulars, address, phone number and email details from the partner's site. tags: - Customers parameters: - name: Authorization in: header description: 'The most recent Authorization token. This will have the format Bearer + {space} + {accessToken}. Example: Bearer KGNsaWVudF9pZDpjbGllbnRfc2VjcmV0KQ==.' type: string required: true - name: uuid in: header description: 128 bit UUID that you generate for every request type: string required: true - name: Accept in: header description: Content-Type that are acceptable for the response type: string required: true - name: client_id in: header description: Client ID generated during application registration. required: true type: string - name: clientDetails in: header description: 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 type: string required: false - name: addressType in: query description: 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. type: string required: false responses: 200: description: Successful operation. schema: $ref: '#/definitions/CustomerProfileResponse' 400: description:
TypeCodeDetails
invalidinvalidRequestMissing or invalid parameters
schema: $ref: '#/definitions/ErrorResponse' 401: description:
errorunAuthorizedAuthorization credentials are missing or invalid
schema: $ref: '#/definitions/ErrorResponse' 403: description:
erroraccessNotConfiguredAccess is not configured for this resource
schema: $ref: '#/definitions/ErrorResponse' 404: description:
errorresourceNotFoundEmpty resource/resource not found
schema: $ref: '#/definitions/ErrorResponse' 500: description:
fatalserverUnavailableThe request failed due to an internal error
schema: $ref: '#/definitions/ErrorResponse' /v1/offers: put: summary: Update Generic Offer description: This API is used to update the generic offer in COPS system. operationId: OfferUpdate tags: - OfferAndDecisionManagement parameters: - name: Authorization in: header description: 'The most recent Authorization token. This will have the format Bearer + {space} + {accessToken}. Example: Bearer KGNsaWVudF9pZDpjbGllbnRfc2VjcmV0KQ==' type: string required: true - name: uuid in: header description: 128 bit random UUID generated uniquely for every request. type: string required: true - name: Accept in: header description: Content-Type that are acceptable for the response. type: string required: true - name: client_id in: header description: Client ID generated during application registration. required: true type: string - name: Content-Type in: header description: application/json required: true type: string - name: clientDetails in: header description: 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 type: string required: false - name: OfferUpdateRequest in: body description: OfferUpdateRequest required: true schema: $ref: '#/definitions/OfferUpdateRequest' responses: 200: description: Successful operation. 400: description:
TypeCodeDetails
invalidinvalidRequestMissing or invalid Parameters
errorinvalidControlFlowIdControl flow Id is invalid
schema: $ref: '#/definitions/ErrorResponse' 401: description:
TypeCodeDetails
errorunAuthorizedAuthorization credentials are missing or invalid
schema: $ref: '#/definitions/ErrorResponse' 403: description:
TypeCodeDetails
erroraccessNotConfiguredThe request operation is not configured to access this resource
schema: $ref: '#/definitions/ErrorResponse' 404: description:
TypeCodeDetails
errorresourceNotFoundEmpty resource/resource not found
schema: $ref: '#/definitions/ErrorResponse' 422: description:
TypeCodeDetails
errorbusinessValidationsFailedBusiness validations failed
schema: $ref: '#/definitions/ErrorResponse' 500: description:
TypeCodeDetails
fatalserverUnavailableThe request failed due to an internal error
schema: $ref: '#/definitions/ErrorResponse' /v1/sales/customers/offers/details: get: summary: Retrieve Offer Details description: This API allows to retrieve the details for an offer. operationId: GetOfferDetails tags: - OfferAndDecisionManagement parameters: - name: Authorization in: header description: 'The most recent Authorization token. This will have the format Bearer + {space} + {accessToken}. Example: Bearer KGNsaWVudF9pZDpjbGllbnRfc2VjcmV0KQ==.' type: string required: true - name: uuid in: header description: 128 bit random UUID generated uniquely for every request. type: string required: true - name: Accept in: header description: Content-Type that are acceptable for the response. type: string required: true - name: client_id in: header description: Client ID generated during application registration. required: true type: string - name: clientDetails in: header description: 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 type: string required: false - name: campaignId in: query description: Unique identifier for a specific campaign being offered to the channel type: string required: false - name: waveId in: query description: Unique identifier for the promotion under specific campaign being offered to the channel type: string required: false - name: accountId in: query description: The account number in encrypted format type: string required: false - name: cardId in: query description: Unique Id of the card in encrypted format type: string required: false - name: offerId in: query description: Unique offer ID associated with the offer type: string required: false - name: offerSegmentCategory in: query description: 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 required: false - name: virtualOfferFlag in: query description: Indicates if offer is virtual type: boolean required: false - name: productCode in: query description: A unique code that identifies the product type: string required: false responses: 200: description: Successful operation. schema: $ref: '#/definitions/GetOfferDetailsResponse' 204: description: No content 400: description:
TypeCodeDetails
invalidinvalidRequestMissing or invalid Parameters
schema: $ref: '#/definitions/ErrorResponse' 401: description:
TypeCodeDetails
errorunAuthorizedAuthorization credentials are missing or invalid
schema: $ref: '#/definitions/ErrorResponse' 403: description:
TypeCodeDetails
erroraccessNotConfiguredThe request operation is not configured to access this resource
schema: $ref: '#/definitions/ErrorResponse' 500: description:
TypeCodeDetails
fatalserverUnavailableThe request failed due to an internal error
schema: $ref: '#/definitions/ErrorResponse' /v1/offers/recommendations: get: summary: Retrieve Offer List based on Product Recommendation description: This API is used to retrieve Customer offer list based on product recommendation received from EAP. operationId: CustomerRecommendedOffersInquiry tags: - OfferAndDecisionManagement parameters: - name: Accept in: header description: Content-Types that are acceptable for the response. Always pass application/json. type: string required: true - name: Accept-Language in: header description: List of acceptable human languages for response. type: string required: false - name: Content-Type in: header description: The MIME type of the body of the request (used with POST and PUT requests). Always pass application/json. type: string required: false - name: uuid in: header description: 128 bit random universally unique identifier (UUID) generated for every request. type: string required: true - name: sid in: header description: Session ID. type: string required: false - name: channelId in: header description: 'Registered channel ID for the consumer. Examples: HBK(CBOL), ECL(Eclipse), MBK(Mobile Banking).' type: string required: true - name: businessCode in: header description: 'Citi business codes. Examples: GCB, VMA, QCC.' type: string required: true - name: countryCode in: header description: 'Country code in ISO 3166 alpha-2 format. Examples: SG(Singapore), PH(Philippines), TH(Thailand).' type: string required: true - name: i-cif in: header description: Unique customer number generated by RM and used in other host systems. type: string required: false - name: x-userID in: header description: SOE ID of the user sending the request. Applicable only for assisted channels like Eclipse. type: string required: false - name: x-userDomicileBranchCode in: header description: Domicile branch code of the user sending the request. Applicable only for assisted channels like Eclipse. type: string required: false - name: x-userDomicileResponsibilityCentre in: header description: Responsibility centre of the user sending the request. Applicable only for assisted channels like Eclipse. type: string required: false - name: x-processingBranchCode in: header description: Branch code where the request is processed. Applicable only for assisted channels like Eclipse. type: string required: false - name: x-processingResponsibilityCentre in: header description: Responsibility centre of the branch where the request is processed. Applicable only for assisted channels like Eclipse. type: string required: false - name: x-userGroup in: header description: 'User group. Applicable only for assisted channels like Eclipse. Examples: CPC(CitiPhone), PWS(Branch), BKO (BackOffice), PWT (Teller), MSF(Mobile Sales Force).' type: string required: false - name: x-sessionLanguageCode in: header description: 'Session language code in ISO 639-1 format. Applicable only for assisted channels like Eclipse. Examples: EN(English), PL(Polish), RU(Russian), ES(Spanish).' type: string required: false - name: i-ccsid in: header description: Customer Credential Store (CCS) unique ID for userID/password. Can be used to uniquely identify a customer in CCS. type: string required: false - name: consumerOrgCode in: header description: Unique code to identify the consumer organization type: string required: false - name: clientDetails in: header description: 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 type: string required: false - name: containerId in: query description: Unique container Id in M63 type: string required: true - name: dynamicOfferCreationFlag in: query description: Flag to indicate if the offers to be created in cops while returning the response type: boolean required: false responses: 200: description: Successful operation. schema: $ref: '#/definitions/CustomerRecommendedOffersInquiryResponse' 204: description: No content 400: description:
TypeCodeDetails
invalidinvalidRequestMissing or invalid parameters
MoreInfoResponseCodeMoreInfoProviderErrorCodeMoreInfoProviderErrorDetails
194INVALID REQUEST PARAMETER
schema: $ref: '#/definitions/ErrorResponse' 401: description:
TypeCodeDetails
errorunAuthorizedAuthorization credentials are missing or invalid
schema: $ref: '#/definitions/ErrorResponse' 403: description:
TypeCodeDetails
erroraccessNotConfiguredThe request operation is not configured to access this resource
schema: $ref: '#/definitions/ErrorResponse' 422: description:
TypeCodeDetails
errorbusinessValidationsFailedBusiness validations failed
MoreInfoResponseCodeMoreInfoProviderErrorCodeMoreInfoProviderErrorDetails
schema: $ref: '#/definitions/ErrorResponse' 500: description:
TypeCodeDetails
fatalserverUnavailableThe request failed due to an internal error
MoreInfoResponseCodeMoreInfoProviderErrorCodeMoreInfoProviderErrorDetails
-1100SYSTEM NOT AVAILABLE
schema: $ref: '#/definitions/ErrorResponse' /v1/sales/customers/offers/fulfillments: post: summary: Fulfill Offer Processing description: This API is used to fulfill the Offer processing. tags: - OfferAndDecisionManagement parameters: - name: Authorization in: header description: 'The most recent Authorization token. This will have the format Bearer + {space} + {accessToken}. Example: Bearer KGNsaWVudF9pZDpjbGllbnRfc2VjcmV0KQ==' type: string required: true - name: uuid in: header description: 128 bit random UUID generated uniquely for every request. type: string required: true - name: Accept in: header description: Content-Type that are acceptable for the response. type: string required: true - name: client_id in: header description: Client ID generated during application registration. required: true type: string - name: Content-Type in: header description: application/json required: true type: string - name: clientDetails in: header description: 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 type: string required: false - name: OfferFulfillmentRequest in: body required: true schema: $ref: '#/definitions/OfferFulfillmentRequest' responses: 200: description: Successful operation. 400: description:
TypeCodeDetails
invalidinvalidRequestMissing or invalid Parameters
errorinvalidOfferOffer is invalid
schema: $ref: '#/definitions/ErrorResponse' 401: description:
errorunAuthorizedAuthorization credentials are missing or invalid
schema: $ref: '#/definitions/ErrorResponse' 403: description:
erroraccessNotConfiguredAccess is not configured for this resource
schema: $ref: '#/definitions/ErrorResponse' 500: description:
fatalserverUnavailableThe request failed due to an internal error
schema: $ref: '#/definitions/ErrorResponse' /v1/customers/profile/images: get: summary: Retrieve Customer Profile Image description: This API is used to retrieve customer's profile image. operationId: CustomerProfileImageInquiry tags: - Customer parameters: - name: Authorization in: header description: 'The most recent Authorization token. This will have the format Bearer + {space} + {accessToken}. Example: Bearer KGNsaWVudF9pZDpjbGllbnRfc2VjcmV0KQ==.' type: string required: true - name: uuid in: header description: 128 bit random UUID generated uniquely for every request. type: string required: true - name: Accept in: header description: Content-Type that are acceptable for the response. type: string required: true - name: client_id in: header description: Client ID generated during application registration. required: true type: string - name: clientDetails in: header description: 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 type: string required: false responses: 200: description: Successful operation. schema: $ref: '#/definitions/CustomerProfileImageInquiryResponse' 204: description: No content 401: description:
TypeCodeDetails
errorunAuthorizedAuthorization credentials are missing or invalid
schema: $ref: '#/definitions/ErrorResponse' 403: description:
TypeCodeDetails
erroraccessNotConfiguredThe request operation is not configured to access this resource
schema: $ref: '#/definitions/ErrorResponse' 422: description:
businessValidationsFailedBusiness validations failed
schema: $ref: '#/definitions/ErrorResponse' 500: description:
TypeCodeDetails
fatalserverUnavailableThe request failed due to an internal error
schema: $ref: '#/definitions/ErrorResponse' put: summary: Update Customer Profile Image description: This API is used to update customer's profile image. operationId: CustomerProfileImageUpdate tags: - Customer parameters: - name: Authorization in: header description: 'The most recent Authorization token. This will have the format Bearer + {space} + {accessToken}. Example: Bearer KGNsaWVudF9pZDpjbGllbnRfc2VjcmV0KQ==.' type: string required: true - name: uuid in: header description: 128 bit random UUID generated uniquely for every request. type: string required: true - name: Accept in: header description: Content-Type that are acceptable for the response. type: string required: true - name: client_id in: header description: Client ID generated during application registration. required: true type: string - name: Content-Type in: header description: application/json required: true type: string - name: clientDetails in: header description: 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 type: string required: false - name: CustomerProfileImageUpdateRequest in: body description: CustomerProfileImageUpdateRequest required: true schema: $ref: '#/definitions/CustomerProfileImageUpdateRequest' responses: 200: description: Successful operation. 401: description:
TypeCodeDetails
errorunAuthorizedAuthorization credentials are missing or invalid
schema: $ref: '#/definitions/ErrorResponse' 403: description:
TypeCodeDetails
erroraccessNotConfiguredThe request operation is not configured to access this resource
schema: $ref: '#/definitions/ErrorResponse' 422: description:
businessValidationsFailedBusiness validations failed
errorfileCorruptedFile is corrupted
errorpayloadTooLargePayload size is larger than the server is willing or able to process
schema: $ref: '#/definitions/ErrorResponse' 500: description:
TypeCodeDetails
fatalserverUnavailableThe request failed due to an internal error
schema: $ref: '#/definitions/ErrorResponse' delete: summary: Delete Customer Profile Image description: This API is used to delete customer's profile image. operationId: CustomerProfileImageDelete tags: - Customer parameters: - name: Authorization in: header description: 'The most recent Authorization token. This will have the format Bearer + {space} + {accessToken}. Example: Bearer KGNsaWVudF9pZDpjbGllbnRfc2VjcmV0KQ==.' type: string required: true - name: uuid in: header description: 128 bit random UUID generated uniquely for every request. type: string required: true - name: Accept in: header description: Content-Type that are acceptable for the response. type: string required: true - name: client_id in: header description: Client ID generated during application registration. required: true type: string - name: Content-Type in: header description: application/json required: true type: string - name: clientDetails in: header description: 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 type: string required: false responses: 200: description: Successful operation. 401: description:
TypeCodeDetails
TypeCodeDetails
errorunAuthorizedAuthorization credentials are missing or invalid
schema: $ref: '#/definitions/ErrorResponse' 403: description:
TypeCodeDetails
TypeCodeDetails
erroraccessNotConfiguredThe request operation is not configured to access this resource
schema: $ref: '#/definitions/ErrorResponse' 422: description:
businessValidationsFailedBusiness validations failed
schema: $ref: '#/definitions/ErrorResponse' 500: description:
TypeCodeDetails
TypeCodeDetails
fatalserverUnavailableThe request failed due to an internal error
schema: $ref: '#/definitions/ErrorResponse' definitions: CustomerProfileImageUpdateRequest: properties: imageFormat: description: Format of the image.This is a reference data field. Please use /v1/utilities/referenceData/{imageFormat} resource to get possible value of this field with description. type: string example: JPG binaryData: description: Binary data of the image type: string example: 32333783180190297547178420321657045879989803522093946636943115216804138800710008984043520.000000 required: - imageFormat - binaryData CustomerProfileImageInquiryResponse: properties: imageFormat: description: Format of the image.This is a reference data field. Please use /v1/utilities/referenceData/{imageFormat} resource to get possible value of this field with description. type: string example: JPG binaryData: description: Binary data of the image type: string example: 32333783180190297547178420321657045879989803522093946636943115216804138800710008984043520.000000 required: - imageFormat - binaryData OfferUpdateRequest: properties: originatingChannelId: description: Name of the origination channel initiating the request. type: string example: CI campaignId: description: Campaign Id of the marketing campaign type: string example: EPP_CAMP waveId: description: Wave id associated with the marketing wave type: string example: WS34565 offerSourceCode: description: The source code for the specific offer type: string example: CPO offerPriority: description: 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 example: 1 offerAssignedByUserId: description: User ID of the user who assigned the offer type: string example: RN66374 offerAssignedToUserId: description: User ID of the user to whom the offer is assigned type: string example: RN66374 offerStatus: description: Offer status type: string example: M offerCategory: description: Category of the offer which indicates the campaign zone it connects to. type: string example: GN userFields: type: array items: $ref: '#/definitions/UserFields' productCode: type: string description: A unique code that identifies the product example: RMPRDCODE controlFlowId: type: string description: Control flow id is used to control the flow for subsequent requests in the session. example: 6e3774334f724a2b7947663653712f52456f524c41797038516a59347a437549564a77755676376e616a733d applicationId: type: string description: Unique identifier for an application. example: RMPRDCODE required: - campaignId - waveId - offerStatus - offerCategory - originatingChannelId UserFields: properties: userFieldsKey: description: User field Key type: string example: 5423392479502010 userFieldsValue: description: User field Key values hold the data that might required type: string example: BCH Fail GetOfferDetailsResponse: properties: offerType: description: 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 example: YEARS_WITH_CITI campaignId: description: Unique identifier for a specific campaign being offered to the channel type: string example: M63UPGDOWNGRADE waveId: description: Unique identifier for the promotion under specific campaign being offered to the channel type: string example: 4BFTUQE5AB waveDescription: description: Description of the benefits of taking the product under the given offer type: string example: 4BFTUQE5AB offerStartDate: description: Start Date of the promotion in ISO 8601 date format YYYY-MM-DD type: string format: date example: "2018-09-06" offerExpiryDate: description: Expiry Date of the promotion in ISO 8601 date format YYYY-MM-DD type: string format: date example: "2018-12-06" offerPriority: description: 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 example: 1 offerProductCode: description: A unique code that identifies the offered product to applicant type: string example: LOPPRELOGIN offerProductDescription: description: Description of the Product for the offer type: string example: LOPPRELOGIN yearsWithCitiRelationship: $ref: '#/definitions/YearsWithCitiRelationship' ecdOffer: type: array items: $ref: '#/definitions/EcdOffer' offerStatus: description: 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 example: INTERESTED merchantRecommendationOffer: $ref: '#/definitions/MerchantRecommendationOffer' customerActionGroup: type: array items: $ref: '#/definitions/CustomerActionGroup' templateFields: type: array items: $ref: '#/definitions/TemplateFields' easyPaymentPlan: $ref: '#/definitions/EasyPaymentPlan' loanOverPhoneOffer: $ref: '#/definitions/LoanOverPhoneOffer' balanceTransferOffer: $ref: '#/definitions/BalanceTransferOffer' genericOffer: $ref: '#/definitions/GenericOffer' customerSegmentChangeOffer: $ref: '#/definitions/CustomerSegmentChangeOffer' required: - offerType - campaignId - waveId YearsWithCitiRelationship: properties: languageCode: description: Preferred language of communication type: string example: eng name: $ref: '#/definitions/Name' relationshipWithCitiInYears: description: Customer relationship in years with Citi type: integer format: int32 example: 3 lastUpgradedCustomerSegment: description: 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 example: CITI_PRIORITY travelDetails: $ref: '#/definitions/TravelDetails' diningDetails: $ref: '#/definitions/DiningDetails' frequentShoppingDetails: $ref: '#/definitions/FrequentShoppingDetails' rewardsDetails: $ref: '#/definitions/RewardsDetails' returnsNetSavingsAmount: description: Net saving money and amount is rounded off to nearest lower 10s type: integer format: int32 example: 20000 returnsNewInvestmentAmount: description: New investment brought in and amount is rounded off to nearest lower 10s. type: integer format: int32 example: 5000 returnsDividendsEarnedAmount: description: Dividends earned and amount is rounded off to nearest lower 10s. type: integer format: int32 example: 1000 returnsTotalGainAmount: description: Total realised and unrealised gain including fees.Amount is rounded off to nearest lower 10s type: integer format: int32 example: 400000 currentCustomerSegment: description: 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 example: CitiBlue goalSubmissionFlag: description: If customer has previosuly submitted the Goals for next financial year type: boolean example: true Name: properties: nameType: description: Type of the name. This is a reference data field. Please use /v1/apac/utilities/referenceData/{nameType} resource to get valid value of this field with description. You can use nameType as the referenceCode parameter to retrieve the values. type: string example: LOCAL_NAME firstName: description: The first name of the customer. Also known as first name type: string example: Javier lastName: description: The last name of the customer. Also known as last name type: string example: de Cuellar fullName: description: Full name of the customer. type: string example: Javier Perez de Cuellar middleName: description: Middle name of the customer. type: string example: Perez required: - firstName TravelDetails: properties: travelledCountryCount: description: This field is to store how many countries customer has travelled in last year type: integer format: int32 example: 2 travelSpendAmount: description: Travel spend Amount ,that is rounded off to nearest lower 10s type: integer format: int32 example: 230 DiningDetails: properties: diningSpendAmount: description: Dining spend Amount ,that is rounded off to nearest lower 10s. type: integer format: int32 example: 10 favouriteDiningPlaces: type: array items: $ref: '#/definitions/FavouriteDiningPlaces' FavouriteDiningPlaces: properties: favouriteDiningPlace: description: Favourite dining places based on highest number of transactions followed by amount spend. type: string example: place1 FrequentShoppingDetails: properties: shoppingSpendAmount: description: Amount spend in shopping segment through debit and credit cards. Amount is rounded off to nearest lower 10s. type: integer format: int32 example: 10000 frequentShoppingPlaces: type: array items: $ref: '#/definitions/FrequentShoppingPlaces' FrequentShoppingPlaces: properties: frequentShoppingPlace: description: Frequent shopping places based on highest number of transactions followed by amount spend. type: string example: camp RewardsDetails: properties: earnedRewardPoints: description: Total number of points earned through all the cards excluding travel and cashback cards type: integer format: int32 example: 1234 earnedRewardMiles: description: Total number of miles earned through travel cards type: integer format: int32 example: 54 earnedRewardCashbackAmount: description: Total amount earned from Citi using the cashback cards and amount is rounded off to nearest lower 1s type: integer format: int32 example: 19988 EcdOffer: properties: productSecurityCode: description: This field is used to stored Product security code if any for ECD (Electronic Certificate of Deposit) offers type: string example: 123456 MerchantRecommendationOffer: properties: offerSegmentCategory: description: 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 example: NEVER_BEEN_THERE offerSegmentScore: description: This is a score that is determined by Offer system in the range of 1 to 100. type: string example: 1 to 200 offerRank: description: The rank is determined/derived by Offer system. It is derived based on the segment and ranking. type: string example: 5 offerMode: description: 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 example: RT_NONGEO,RT_GEO, BATCH localOverseasIndicator: description: 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 example: LOCAL, OVERSEAS merchantCatagory: description: 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 example: DINING, TRAVEL, INSURANCE, ACCESSORIES, GENERAL, APPARELLS, SPORTS CustomerActionGroup: properties: customerAction: description: 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 example: LIKE,DISLIKE customerActionDateTime: description: Customer action date-time in ISO 8601 date format YYYY-MM-DDTHH:MM:SS type: string example: "2018-11-11 22:21:23" TemplateFields: properties: templateFieldKey: description: Template variable key type: string example: txnParam1 templateFieldValue: description: Template variable value type: string example: abc EasyPaymentPlan: properties: customerAccountDetails: $ref: '#/definitions/CustomerAccountDetails' promotionId: description: Unique identifier for a specific promotion being offered for a specific campaign/offer type: string example: R68BGK merchantOrganizationNumber: description: Merchant organization number for the perticular merchant type: string example: 123 merchantNumber: description: Unique identifier associated with the merchant type: string example: 4578 offerIndicator: description: 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 example: "Y" creditLimitPercentage: description: percentages of that perticular credit limit type: number format: double example: 8 eppMinimumEligibleAmount: description: minimum Amount which eligible for that customer type: number format: double example: 1234 eppMaximumEligibleAmount: description: maximum Amount which eligible for that customer type: number format: double example: 5432 tenorAndInterestDetails: $ref: '#/definitions/TenorAndInterestDetails' transactionDetails: $ref: '#/definitions/TransactionDetails' CustomerAccountDetails: properties: cardId: description: The card id in encrypted format type: string example: 3255613852316f2b4d4d796c344e38756339654972776f663745446e6d4c32486f455a4165374a476858343d displayCardNumber: description: A masked card number that can be displayed to the customer type: string example: XXXXXXXXXXXX4521 accountId: description: The customer account identifier in encrypted format type: string example: 3255613852316f2b4d4d796c344e38756339654972776f663745446e6d4c32486f455a4165374a476858343d accountGroup: description: Account group is a classification of accounts according to their common characteristics. This is a reference data field. Please use /v1/utilities/referenceData/{accountGroup} resource to get valid value of this field with description. type: string example: MERCHANT TenorAndInterestDetails: properties: feePercentage: description: Fee percantage to the card or customer type: number format: double example: 3 effectiveInterestRate: description: Effective interest rate of applicable to customer type: number format: double example: 4 nominalInterestRate: description: Mandatory for rate/hybrid based offers. Applicable nominal interest rate for different tenors. type: number format: double example: 5 tenor: description: detail info about tenor for that perticular offer/Customer type: integer format: int32 example: 60 TransactionDetails: properties: transactionDate: description: ransaction date in YYYY-MM-DD format value conforming to ISO 8601 type: string format: date example: "2018-12-06" transactionCode: description: details of Transaction code for that perticular transaction type: string example: ABLKJ transactionAmount: description: details of Transaction amount for that perticular transaction type: number format: double example: 1234 transactionDescription: description: details of Transaction description for that perticular transaction type: string example: Account has been credited transactionReferenceId: description: Reference Id to uniquely identify the transaction. type: string example: ALKJ78 transactionAuthorizationCode: description: Transaction authorization code is a unique to a sales credit card transaction to indicate that the sale has been authorized. This is applicable only for pending transactions type: string example: ABC required: - transactionDate - transactionReferenceId - transactionAuthorizationCode LoanOverPhoneOffer: properties: customerAccountDetails: $ref: '#/definitions/CustomerAccountDetails' promotionId: description: Unique identifier for a specific promotion being offered for a specific campaign/offer type: string example: R68BGK offerIndicator: description: 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 example: Y/N tenorAndInterestDetails: $ref: '#/definitions/TenorAndInterestDetails' creditLimitPercantage: description: percentages of that perticular credit limit type: number format: double example: 3 monthlyFlatRate: description: This field is used to specify maximum monthly flat rate type: number format: double example: 2 lopMinimumEligibleAmount: description: Minimum eligible amount for which loan over phone can be booked type: number format: double example: 6768 lopMaximumEligibleAmount: description: Maximum eligible amount for which loan over phone Plan can be booked. type: number format: double example: 80909 lopIndicator: description: 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 example: "Y" required: - offerType - campaignId - waveId BalanceTransferOffer: properties: customerAccountDetails: $ref: '#/definitions/CustomerAccountDetails' promotionId: description: Unique identifier for a specific promotion being offered for a specific campaign/offer type: string example: R68BGK offerIndicator: description: 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 example: Y/N eligibleLoanAmount: description: Recommended loan amount type: number format: double example: 3 tenorAndInterestDetails: $ref: '#/definitions/TenorAndInterestDetails' creditLimitPercantage: description: percentages of that perticular credit limit type: number format: double example: 3 btMinimumEligibleAmount: description: Minimum eligible amount for which balance transfer can be booked. type: number format: double example: 5000.250000 btMaximumEligibleAmount: description: Maximum eligible amount for which balance transfer can be booked. type: number format: double example: 10000.250000 required: - offerType - campaignId - waveId GenericOffer: properties: customerAccountDetails: $ref: '#/definitions/CustomerAccountDetails' required: - offerType - campaignId - waveId CustomerSegmentChangeOffer: properties: currentCustomerSegment: description: 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 example: CITI_PRIORITY previousCustomerSegment: description: 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 example: CITI_BLUE customerSegmentChangeDate: description: Customer segment change date in ISO 8601 date format YYYY-MM-DD type: string format: date example: "2018-12-06" targetTrbDifferentAmount: description: Difference in amount in current TRB(Total Releationship Balance amount) to next segment threshold amount type: number format: double example: 7890 segmentChangeOfferCode: description: 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: ABC6798 required: - offerType - campaignId - waveId CustomerRecommendedOffersInquiryResponse: properties: recommendedOffers: type: array items: $ref: '#/definitions/RecommendedOffer' required: - recommendedOffers RecommendedOffer: properties: offerType: description: Type of offer. type: string example: easyPaymentPlanOffer campaignId: description: Unique identifier for a specific campaign being offered to the channel type: string example: 123456789 waveId: description: Unique identifier for the promotion under specific campaign being offered to the channel type: string example: 123456789 waveDescription: description: Description of the benefits of taking the product under the given offer type: string example: Waiver of the annual fees for the first 2 years displayAccountNumber: type: string description: A masked account number that can be displayed to the customer example: XXXXXX2391 displayCardNumber: description: A masked card number that can be displayed to the customer type: string example: XXXXXXXXXXXX0368 cardId: description: The card id in encrypted format type: string example: 44125873852316f2b4d4d796c344e38756339654972776f663745446e6d4c32486f455a4165374a476858343d accountId: description: The customer account identifier in encrypted format type: string example: 3255613852316f2b4d4d796c344e38756339654972776f663745446e6d4c32486f455a4165374a476858343d offerStartDate: description: Start Date of the promotion in ISO 8601 date format YYYY-MM-DD type: string format: date example: "2016-10-06" offerExpiryDate: description: End date of the promotion in ISO 8601 date format YYYY-MM-DD type: string format: date example: "2016-12-08" offerPriority: description: 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 example: 1 virtualOfferFlag: description: Flag to indicate if the offer is a virtual offer or not type: boolean example: "true" geoGraphicalLocation: $ref: '#/definitions/GeoGraphicalLocation' productCode: description: A unique code that identifies the product type: string example: 0500_VC901 productDescription: description: Detailed information about offered product type: string example: Citibank SMRT Visa Card tenorAndInterestDetails: type: array items: $ref: '#/definitions/TenorAndInterestDtls' userFields: type: array items: $ref: '#/definitions/UserFields' required: - offerType - campaignId - waveId - productCode GeoGraphicalLocation: properties: latitude: description: Latitude value for the geographical location of the location type: string example: 34.123000 longitude: description: Longitude value for the geographical location of the location type: string example: 54.100000 TenorAndInterestDtls: properties: feePercentage: description: Indicates the percentage of fee associated with this offer type: number format: double example: 2.100000 effectiveInterestRate: description: Effective interest rate type: number format: double example: 4.210000 nominalInterestRate: description: Nominal refer to the advertised or stated interest rate on a loan, without taking into account any fees or compounding of interest. type: number format: double example: 0.720000 tenor: description: Offer tenure type: integer format: int32 example: 5 required: - tenor OfferFulfillmentRequest: properties: campaignId: description: Unique identifier for a specific campaign being offered to the channel type: string example: 123456789 waveId: description: Unique identifier for the promotion under specific campaign being offered to the channel type: string example: 123456789 offerType: description: Type of offer. This is a reference data field. Please use /v1/apac/utilities/referenceData/{offerType} resource to get valid value of this field with description. type: string example: CREDIT_LIMIT_INCREASE creditLimitOfferFulfillment: $ref: '#/definitions/CreditLimitOfferFulfillment' required: - campaignId - waveId - offerType CreditLimitOfferFulfillment: properties: cardId: description: The card id in encrypted format type: string example: 3255613852316f2b4d4d796c344e38756339654972776f663745446e6d4c32486f455a4165374a476858343d offeredCreditLimitConsentFlag: description: 'Customer consent on the offered credit limit. Valid values: true and false' type: boolean example: true required: - cardId - offeredCreditLimitConsentFlag CustomerProfileUpdateRequest: properties: addressList: type: array items: $ref: '#/definitions/Address' emails: type: array items: $ref: '#/definitions/Email' phones: type: array items: $ref: '#/definitions/Phone' customerParticulars: $ref: '#/definitions/CustomerParticulars' demographics: $ref: '#/definitions/Demographics' contactConsent: $ref: '#/definitions/ContactConsent' identificationDocumentDetails: type: array items: $ref: '#/definitions/IdentificationDocumentDetails' employmentDetails: type: array items: $ref: '#/definitions/EmploymentDetails' documentId: description: Document ID generated by Documentum during document upload type: string example: 0902684B802480029 IdentificationDocumentDetails: properties: idType: description: Type of Identification document. This is a reference data field. Please use /v1/utilities/referenceData/{idType} resource to get valid values of this field with descriptions type: string example: PASSPORT primaryIdFlag: description: 'Flag to mark primary identification document. Valid values: true and false' type: boolean example: true idNumber: description: 'Unique identifier of identification document. Ex: Passport Number' type: string example: S42258011 idExpiryDate: description: Expiry date of identification document in ISO 8601 date format YYYY-MM-DD type: string format: date example: "2027-04-11" idIssueDate: description: Issuance date of identification document in ISO 8601 date format YYYY-MM-DD type: string format: date example: "2017-04-12" idIssuePlace: description: Identification document issuance place type: string example: Brisbane idIssueCountry: description: Country of issuance. This is a reference data field. Please use /v1/utilities/referenceData/{country} resource to get valid value of this field with description. type: string example: AU EmploymentDetails: properties: employerName: description: Name of the employer. type: string example: Citi Bank jobTitle: description: Job Title. This is a reference data field. Please use /v1/utilities/referenceData/{jobTitle} resource to get valid value of this field with description. type: string example: ACCOUNTANT occupationCode: description: Occupation code. This is a reference data field. Please use /v1/utilities/referenceData/{occupationCode} resource to get valid value of this field with description. type: string example: ACCOUNTANT otherOccupationDescription: description: Other Occupation details entered by the Applicant.This is applicable if Applicant selects Others from the occupation Code drop down type: string example: Relationship Manager industryCode: description: Code of the industry of employment. This is a reference data field. Please use /v1/utilities/referenceData/{industryCode} resource to get valid value of this field with description. type: string example: CITIBANK_SUB_NON_BANK employmentDurationInYears: description: Employment duration in years type: integer example: 5 emailAddress: description: Employer's email address type: string example: matt.hayden@abc.com employmentStatus: description: Status of the employment.This is a reference data field. Please use /v1/apac/utilities/referenceData/{employmentStatus} resource to get valid value of this field with description. type: string example: RETIRED employmentStartDate: description: Employment start date in ISO 8601 date format YYYY-MM-DD type: string format: date example: "2010-12-31" ContactConsent: properties: okToCall: description: 'Customer''s consent for receiving phone calls. Valid values: true and false' type: boolean example: true okToMail: description: 'Customer''s consent for receiving mails. Valid values: true and false' type: boolean example: true okToEmail: description: 'Customer''s consent for receiving email. Valid values: true and false' type: boolean example: true okToSms: description: 'Customer''s consent for receiving sms. Valid values: true and false' type: boolean example: true okToPushNotification: description: 'Customer''s consent for push notification ' type: boolean example: false CustomerParticulars: properties: names: type: array items: $ref: '#/definitions/Name' gender: description: Gender/Sex. Valid values are MALE, FEMALE for individual customer types and OTHERS for corporate customers.This is a reference data field. Please use /v1/apac/utilities/referenceData/{gender} resource to get valid value of this field with description. You can use gender as the referenceCode parameter to retrieve the values. type: string prefix: description: The prefix of the customer s name. type: string example: Mr. suffix: description: The suffix of the customer s name. type: string example: III Demographics: properties: dateOfBirth: description: Aadhaar number holders date of birth in ISO 8601 date format YYYY-MM-DD type: string format: date example: "1988-10-01" gender: description: Valid values are "M" for male, "F" for female, and "T" for transgender. type: string example: M Address: properties: addressKey: description: Unique identifier of the address and it is mandatory in update customer address details type: integer example: 1 city: description: City type: string example: Abbeywood addressType: description: 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 example: HOME_ADDRESS postalCode: description: Postal code the mailing address type: string example: QLD 4613 addressline3: description: Address line3 of the mailing address type: string example: Broadway Avenue addressline2: description: Address line2 of the mailing address type: string example: 99 George Street addressline1: description: Address line1 of the mailing address type: string example: Post Box 56 state: description: 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 example: QUEENSLAND countryName: description: 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 example: AUSTRALIA addressline4: description: Address line3 of the mailing address type: string example: Wandaloo ESP required: - postalCode - countryName - addressType CountrySpecificAddress: properties: village: description: Customer's village type: string example: sentosa subDistrict: description: Customer's sub district type: string example: keppel regencyCode: description: Customers regency code.This is a reference data field. Please use /v1/utilities/referenceData/{regencyCode} resource to get valid values of this field with descriptions type: string example: 7201 BL KAB. BULELENG provinceCode: description: Province Code type: string example: Singapore Email: properties: emailAddress: description: Updated email address of the customer type: string example: javier123@yahoo.com preferredEmailFlag: description: Flag to indicate the preferred email type: boolean example: true emailKey: description: Unique identifier of the email address type: integer example: 1 required: - emailKey - emailAddress - preferredEmailFlag Phone: properties: phoneType: description: 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 example: HOME_PHONE_NUMBER areaCode: description: Area code of telephone number type: string example: "02" extension: description: Extension of telephone number type: string example: 23 phoneKey: description: Unique identifier of the phone number type: integer example: 1 phoneNumber: description: The phone number of a customer type: string example: 427671760 phoneCountryCode: description: 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: 61 required: - phoneKey - phoneType - phoneNumber - phoneCountryCode CustomerProfileUpdateResponse: properties: profileUpdateStatus: type: array items: $ref: '#/definitions/ProfileUpdateStatus' ProfileUpdateStatus: properties: profileUpdateStatusCode: description: This is the status code of the customer profile update. This is a reference data field. Please use /v1/apac/utilities/referenceData/{profileUpdateStatusCode} resource to get valid value of this field with description. type: string example: EMAIL_AND_PHONE_UPDATE_SUCCESS profileUpdateFailureReason: description: This field is to indicate the reason of the failure of profile update. Applicable only incase any error in profile updates. type: string example: E-mail update failed required: - profileUpdateStatusCode CustomerEmailUpdateRequest: properties: email: type: array items: $ref: '#/definitions/Email' required: - email CustomerAddressUpdateRequest: properties: address: type: array items: $ref: '#/definitions/Address' required: - address Card: properties: cardId: description: The customer card identifier in encrypted format type: string example: 3255613852316f2b4d4d233213344e38756339654972776f663745446e6d4c32486f455a4165374a476858343d mailingIndicator: description: Mailing Indicator . Please use /utilities/referenceData/{mailingIndicator} resource to get valid values of this field with descriptions. type: string example: CORPORATE_RESIDENCE CustomerPhoneUpdateRequest: properties: phone: type: array items: $ref: '#/definitions/Phone' required: - phone CustomerProfileResponse: properties: emails: type: array items: $ref: '#/definitions/Email' customerType: description: 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 example: INDIVIDUAL customerParticulars: $ref: '#/definitions/CustomerParticulars' customerSegment: description: 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 example: BLUE partnerCustomerSegment: description: 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 example: AD1 addressList: type: array items: $ref: '#/definitions/Address' phones: type: array items: $ref: '#/definitions/Phone' required: - customerSegment KycInformation: properties: usTaxStatus: description: US Tax status. This is a reference data field. Please use /v1/utilities/referenceData/{usTaxStatus} resource to get valid value of this field with description. You can use usTaxStatus field name as the referenceCode parameter to retrieve the values. type: string example: US_PERSON_REPORTABLE_DOCUMENTED usTaxId: description: US Tax ID type: string example: US234567 usTaxIdCertificationDate: description: US Tax id certification date in ISO 8601 date format YYYY-MM-DD. For US its the W-9 Sign Date type: string format: date example: "2016-02-21" nonResidentTaxCertificationStrtDate: description: Tax Certification valid from date for non resident in ISO 8601 date format YYYY-MM-DD.For US its the W-9 Since type: string format: date example: "2016-02-21" nonResidentTaxCertificationExpDate: description: 'Tax Certification expiry date for non resident in ISO 8601 date format YYYY-MM-DD.For US its the W-8 Expiry Date ' type: string format: date example: "2018-02-21" usResidencyStatus: description: US Residency Status.Please use /v1/utilities/referenceData/{usResidencyStatus} resource to get valid value of this field with description. type: string example: US_CITIZEN EducationDetails: properties: highestEducationLevel: description: Highest education level of the applicant. This is a reference data field. Please use /v1/utilities/referenceData/{highestEducationLevel} resource to get valid value of this field with description. type: string example: MASTER FinancialInformation: properties: incomeDetails: type: array items: $ref: '#/definitions/IncomeDetails' IncomeDetails: properties: incomeType: description: Applciants income type. This is a reference data field. Please use /utilities/referenceData/{incomeType} resource to get valid values of this field with descriptions. type: string example: DECLARED_FIXED fixedAmount: description: Fixed income amount of applicant type: number format: double example: 5000.250000 variableAmount: description: Variable income amount of applicant type: number format: double example: 3500.250000 frequency: description: Income Frequency. This a reference data field. Please use /v1/utilities/referenceData/{frequency} resource to get valid values of this field with descriptions. type: string example: MONTHLY required: - incomeType - frequency 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 AadhaarOtpResponse: properties: transactionId: description: Transaction Id for subsequent API request type: string example: adf44sfsdf234sdfsfsf 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: $ref: '#/definitions/BiometricIdentity' required: - aadhaarNumber - customerReferenceKey - customerReferenceValue - residentConsentGivenFlag - verificationType BiometricIdentity: properties: deviceDetails: $ref: '#/definitions/DeviceDetails' 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 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 AadhaarEkycResponse: properties: fullName: description: Full name of the Aadhaar number holder as provided by the Aadhaar holder during enrolment or later updates type: string example: Kumar Singh demographics: $ref: '#/definitions/Demographics' address: $ref: '#/definitions/AddressKyc' aadhaarNumber: description: Aadhaar number type: string example: "873487387487" transactionId: description: Transaction id echoback type: string example: adf44sfsdf234sdfsfsf required: - transactionId AddressKyc: properties: careOfFullName: description: Aadhaar number holders address care of name as provided by the Aadhaar holder during enrolment or later updates. type: string example: Kumar Arya houseNumber: description: House Number as provided by the Aadhaar holder during enrolment or later updates type: string example: 1170 streetName: description: Street Name as provided by the Aadhaar holder during enrolment or later updates type: string example: Arbindo Marg landmark: description: Landmark as provided by the Aadhaar holder during enrolment or later updates type: string example: Near Bus Stop locality: description: Locality as provided by the Aadhaar holder during enrolment or later updates type: string example: Sec-3,Bharat Nagar villageTownCity: description: 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 example: Trans Hindon subDistrict: description: Sub District as provided by the Aadhaar holder during enrolment or later updates type: string example: Ghaziabad district: description: District name as provided by the Aadhaar holder during enrolment or later updates type: string example: Ghaziabad state: description: State name as provided by the Aadhaar holder during enrolment or later updates type: string example: Uttar Pradesh postalcode: description: Postal Code name as provided by the Aadhaar holder during enrolment or later updates type: string example: INDIA postoffice: description: Post Office name as provided by the Aadhaar holder during enrolment or later updates type: string example: 201012 CustomerParticularResponse: properties: customerType: description: 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 example: INDIVIDUAL customerParticulars: $ref: '#/definitions/CustomerParticulars' customerSegment: description: 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. Mandatory if partnerCustomerSegment is not present. type: string example: BLUE partnerCustomerSegment: description: 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. Mandatory if customerSegment is not present. type: string example: AD1 CustomerAddressResponse: properties: addressList: type: array items: $ref: '#/definitions/Address' required: - addressList CustomerAddressUpdateConfirmationRequest: properties: controlFlowId: description: Control Flow Id type: string example: 6e3774334f724a2b7947663653712f52456f524c41797038516a59347a437549564a77755676376e616a733d required: - controlFlowId CustomerEmailResponse: properties: emails: type: array items: $ref: '#/definitions/Email' required: - emails CustomerEmailUpdateConfirmationRequest: properties: controlFlowId: description: Control Flow Id type: string example: 6e3774334f724a2b7947663653712f52456f524c41797038516a59347a437549564a77755676376e616a733d required: - controlFlowId CustomerPhoneResponse: properties: phones: type: array items: $ref: '#/definitions/Phone' required: - phones CustomerPhoneUpdateConfirmationRequest: properties: controlFlowId: description: Control Flow Id type: string example: 6e3774334f724a2b7947663653712f52456f524c41797038516a59347a437549564a77755676376e616a733d required: - controlFlowId ErrorResponse: 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 x-ibm-configuration: enforced: true testable: true phase: realized consumes: - application/json securityDefinitions: API Key: type: apiKey description: "" in: header name: X-IBM-Client-Id security: - API Key: [] x-ibm-endpoints: - endpointUrl: https://sandbox.apihub.citi.com/gcb description: Custom Gateway API Endpoint type: - production - development ...