--- swagger: "2.0" info: description: The Customers API allows you to retrieve basic Citi customer information like name, mailing address, email address and phone numbers. title: Customers version: 1.0.0 x-ibm-name: customers_100 basePath: /api schemes: - https x-ibm-configuration: enforced: true phase: realized testable: true tags: [] definitions: 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 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 CustomerAddressUpdateRequest: properties: address: type: array items: $ref: '#/definitions/Address' required: - address 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 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 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 ErrorResponse: properties: 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 type: description: Invalid - Request did not confirm to the specification and was unprocessed and rejected. Please fix the value and try again type: string enum: - error - warn - invalid - fatal moreInfo: description: URI to human readable documentation of the error type: object required: - type - code CustomerPhoneResponse: properties: phones: type: array items: $ref: '#/definitions/Phone' required: - phones CustomerAddressResponse: properties: addressList: type: array items: $ref: '#/definitions/Address' required: - addressList 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 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 CustomerEmailResponse: properties: emails: type: array items: $ref: '#/definitions/Email' required: - emails CustomerEmailUpdateRequest: properties: email: type: array items: $ref: '#/definitions/Email' required: - email securityDefinitions: API Key: type: apiKey name: X-IBM-Client-Id in: header description: "" paths: /v1/customers/profiles: get: summary: Retrieve Customer All Information description: Returns the Citi customer's name, email address, mailing address and phone numbers. 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 /v1/customers/profiles/addresses: get: summary: Retrieve Customer Address description: Returns the Citi customer's primary mailing address. 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 description: Sets the Citi customer's primary address responses: 200: description: Successful operation. 400: schema: $ref: '#/definitions/ErrorResponse' description:
TypeCodeDetails
invalidinvalidRequestMissing or invalid Parameters
errorexceededMaximumAllowedAddressesExceeded maximum allowed addresses
erroraddressAdditionFailedAddition of address is not supported
401: schema: $ref: '#/definitions/ErrorResponse' description:
errorunAuthorizedAuthorization credentials are missing or invalid
403: schema: $ref: '#/definitions/ErrorResponse' description:
erroraccessNotConfiguredThe request operation is not configured to access this resource
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 - in: header name: Content-Type description: application/json type: string required: true - schema: $ref: '#/definitions/CustomerAddressUpdateRequest' in: body name: CustomerAddressUpdateRequest description: Request required: true /v1/customers/profiles/basic: get: summary: Retrieve Customer Basic Name description: Returns the Citi customer's name, including 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/emails: get: summary: Retrieve Customer Email description: Returns the Citi customer's email address. 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: Sets the Citi customer's email address responses: 200: description: Successful operation. 400: schema: $ref: '#/definitions/ErrorResponse' description:
TypeCodeDetails
invalidinvalidRequestMissing or invalid Parameters
errorexceededMaximumAllowedEmailsExceeded maximum allowed emails
401: schema: $ref: '#/definitions/ErrorResponse' description:
errorunAuthorizedAuthorization credentials are missing or invalid
403: schema: $ref: '#/definitions/ErrorResponse' description:
erroraccessNotConfiguredThe request operation is not configured to access 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 - in: header name: Content-Type description: application/json type: string required: true - schema: $ref: '#/definitions/CustomerEmailUpdateRequest' in: body name: CustomerEmailUpdateRequest required: true /v1/customers/profiles/phoneNumbers: get: summary: Retrieve Customer Phone Number description: Returns the Citi 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: Sets the Citi customer's phone numbers, which include Home, Office and Mobile responses: 200: description: Successful operation. 400: schema: $ref: '#/definitions/ErrorResponse' description:
TypeCodeDetails
invalidinvalidRequestMissing or invalid Parameters
errorexceededMaximumAllowedPhonesExceeded maximum allowed phones
401: schema: $ref: '#/definitions/ErrorResponse' description:
errorunAuthorizedAuthorization credentials are missing or invalid
403: schema: $ref: '#/definitions/ErrorResponse' description:
erroraccessNotConfiguredThe request operation is not configured to access 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 - in: header name: Content-Type description: application/json type: string required: true - schema: $ref: '#/definitions/CustomerPhoneUpdateRequest' in: body name: CustomerPhoneUpdateRequest required: true security: - API Key: [] consumes: - application/json produces: - application/json x-ibm-endpoints: - endpointUrl: https://sandbox.apihub.citi.com/gcb description: Custom Gateway API Endpoint type: - production - development ...