I am developing for the

market, looking for the

API Documentation.

Home

>

API Products

>

United Kingdom - Customers API Documentation

Customers

Summary

The Customers API allows you to retrieve basic Citi customer information's

The Customers API uses the authorization_code grant type, for authorization details CLICK HERE

Want to try this API out on our Playground?

Go play now
Endpoints on this page
get /v1/customers/profiles Retrieve Customer All Information
get /v1/customers/profiles/basic Retrieve Customer Basic Name

Retrieve Customer All Information

get /v1/customers/profiles
Description

Returns the Citi customer's name, email address, mailing address and phone numbers.

Header Parameters
Authorization
string required
The most recent Authorization token. This will have the format Bearer + {space} + {accessToken}. Example: Bearer KGNsaWVudF9pZDpjbGllbnRfc2VjcmV0KQ==.
uuid
string required
128 bit UUID that you generate for every request
Accept
string required
Content-Type that are acceptable for the response
client_id
string required
Client ID generated during application registration.
clientDetails
string Optional
This field is used to capture device,browser and network information. Refer the developer portal for more information.These are the fields which will be passed as part of the header devicePrint,deviceTokenCookie,userIpAddress,userAgent,hardwareId,simId,deviceModel,deviceName,deviceOsName,deviceOsVersion,multitaskingSupportFlag,languageSupport,wifiMacAddress,cellTowerId,locationAreaCode,rsaApplicationKey,wapClientId,mobileCarrierCode,mobileCountryCode,osId,geoLongitude,geoLatitude,geoHorizontalAccuracy,geoAltitude,geoAltitudeAccuracy,geoSpeed,geoTimestamp,geoStatus,basicServiceSetId,signalStrength,wifiChannel,serviceSetId
Query Parameters
addressType
string Optional
Type of the address. This is a reference data field. Please use /v1/utilities/referenceData/{addressType} resource to get valid value of this field with description.
  • cURL
  • Ruby
  • Python
  • PHP
  • Java
  • Node
  • Go
  • Swift

Example Request

Example Request

Example Request

Example Request

Example Request

Example Request

Example Request

Example Request

Responses
200

Successful operation.
Definitions
  • customerType
    • Type of the customer. This is applicable only for Individual customers.This is a reference data field. Please use /v1/utilities/referenceData/{customerType} resource to get valid value of this field with description.
    • type : string
  • customerSegment
    • 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
  • partnerCustomerSegment
    • Partner customer segment.This is a reference data field. Please use /v1/utilities/referenceData/{partnerCustomerSegment} resource to get possible value of this field with description.
    • type : string
  • phoneNumberUpdateAllowedFlag
    • To indicate whether the phone Number is allowed to be updated by the customer.
    • type : boolean
  • taxComplianceCertificationFlag
    • Flag to indicate if customer has certification on tax compliance.
    • type : boolean
  • addressUpdateAllowedFlag
    • Flag to indicate whether the address is allowed to be updated by the customer
    • type : boolean
  • customerParticulars
      • names
        • properties : Array
      • prefix
        • The prefix of the customer s name.
        • type : string
      • suffix
        • The suffix of the customer s name.
        • type : string
  • demographics
      • dateOfBirth
        • Applicant's date of birth in ISO 8601 date format YYYY-MM-DD
        • type : string
        • format : date
      • placeOfBirth
        • Applicant's place of birth
        • type : string
      • countryOfBirth
        • Applicant's Country of birth. This is a reference data field. Please use /v1/utilities/referenceData/{country} resource to get valid value of this field with description.
        • type : string
      • residenceCountryCode
        • This field is to indicate the country of residence. This is a reference data field. Please use /v1/utilities/referenceData/{country} resource to get valid value of this field with description.
        • type : string
      • nationality
        • Applicant's nationality. This is a reference data field. Please use /v1/utilities/referenceData/{country} resource to get valid value of this field with description.
        • type : string
      • maritalStatus
        • Applicant's marital status. This is a reference data field. Please use /v1/utilities/referenceData/{maritalStatus} resource to get valid value of this field with description.
        • type : string
      • residencyStatus
        • Indicate status of residence. This is a reference data field. Please use /v1/utilities/referenceData/{residenceStatus} resource to get valid value of this field with description.
        • type : string
      • residenceType
        • Type of Residence. This is a reference data field. Please use /v1/utilities/referenceData/{residenceType} resource to get valid value of this field with description.
        • type : string
      • secondOtherNationalityCountryCode
        • Applicant's second nationality country code. This is a reference data field. Please use /v1/utilities/referenceData/{country} resource to get valid value of this field with description.
        • type : string
      • thirdOtherNationalityCountryCode
        • Applicant's second nationality country code. This is a reference data field. Please use /v1/utilities/referenceData/{country} resource to get valid value of this field with description.
        • type : string
      • fourthOtherNationalityCountryCode
        • Applicant's second nationality country code. This is a reference data field. Please use /v1/utilities/referenceData/{country} resource to get valid value of this field with description.
        • type : string
      • fifthOtherNationalityCountryCode
        • Applicant's second nationality country code. This is a reference data field. Please use /v1/utilities/referenceData/{country} resource to get valid value of this field with description.
        • type : string
  • addressList
      • addressKey
        • Unique identifier of the address and it is mandatory in update customer address details
        • type : integer
      • addressline1
        • address line1 of the mailing address
        • type : string
      • addressline2
        • address line2 of the mailing address
        • type : string
      • addressline3
        • address line3 of the mailing address
        • type : string
      • addressline4
        • address line4 of the mailing address
        • type : string
      • addressType
        • 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
      • district
        • District name
        • type : string
      • city
        • City
        • type : string
      • state
        • State. This is a ref data field. Please use /v1/utilities/referenceData/{addressState} resource to get valid value of this field with description.
        • type : string
      • postalCode
        • Postal code the mailing address
        • type : string
      • countryName
        • Country Name. This is a reference data field. Please use /v1/utilities/referenceData/{countryName} resource to get valid value of this field with description.
        • type : string
      • countrySpecificAddress
        • properties : Array
  • emails
      • emailKey
        • Unique identifier of the email address
        • type : integer
      • emailAddress
        • Email address of the customer
        • type : string
      • preferredEmailFlag
        • Flag to indicate the preferred Email.
        • type : boolean
      • emailType
        • The type of email. This is a reference data field. Please use /v1/utilities/referenceData/{emailType} resource to get valid value of this field with description.
        • type : string
  • phones
      • phoneKey
        • Unique identifier of the phone number.
        • type : integer
      • phoneType
        • The type of phone. This is a reference data field. Please use /v1/utilities/referenceData/{phoneType} resource to get valid value of this field with description.
        • type : string
      • phoneNumber
        • The phone number of a customer
        • type : string
      • phoneCountryCode
        • Country code in ISO 3166 format
        • type : string
      • areaCode
        • Area code of telephone number
        • type : string
      • extension
        • Extension of telephone number
        • type : string
  • identificationDocumentDetails
      • idType
        • 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
      • primaryIdFlag
        • Flag to mark primary identification document. Valid values: true and false
        • type : boolean
      • idNumber
        • Unique identifier of identification document. Ex: Passport Number
        • type : string
      • idExpiryDate
        • Expiry date of identification document in ISO 8601 date format YYYY-MM-DD
        • type : string
        • format : date
      • idIssueDate
        • Issuance date of identification document in ISO 8601 date format YYYY-MM-DD
        • type : string
        • format : date
      • idIssuePlace
        • Identification document issuance place
        • type : string
      • idIssueCountry
        • 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
  • educationDetails
      • highestEducationLevel
        • 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
  • employmentDetails
      • employerName
        • Name of the employer.
        • type : string
      • jobTitle
        • 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
      • occupationCode
        • 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
      • otherOccupationDescription
        • Other Occupation details entered by the Applicant.This is applicable if Applicant selects Others from the occupation Code drop down
        • type : string
      • industryCode
        • 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
      • employmentDurationInYears
        • Employment duration in years
        • type : integer
      • emailAddress
        • Employer's email address
        • type : string
      • employmentStatus
        • 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
      • employmentStartDate
        • Employment start date in ISO 8601 date format YYYY-MM-DD
        • type : string
        • format : date
  • financialInformation
      • incomeDetails
        • properties : Array
  • kycInformation
      • usTaxStatus
        • 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
      • usTaxId
        • US Tax ID
        • type : string
      • usTaxIdCertificationDate
        • 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
      • nonResidentTaxCertificationStrtDate
        • 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
      • nonResidentTaxCertificationExpDate
        • 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
      • usResidencyStatus
        • US Residency Status.Please use /v1/utilities/referenceData/{usResidencyStatus} resource to get valid value of this field with description.
        • type : string
Example Response for get /v1/customers/profiles
{
    "customerType": "INDIVIDUAL",
    "customerSegment": "BLUE",
    "partnerCustomerSegment": "AD1",
    "phoneNumberUpdateAllowedFlag": true,
    "taxComplianceCertificationFlag": true,
    "addressUpdateAllowedFlag": true,
    "customerParticulars": {
        "names": {
            "firstName": "Javier",
            "lastName": "de Cuellar",
            "nameType": "LOCAL_NAME",
            "middleName": "Perez",
            "fullName": "Javier Perez de Cuellar"
        },
        "prefix": "Mr.",
        "suffix": "III"
    },
    "demographics": {
        "dateOfBirth": "1972-09-15",
        "placeOfBirth": "Sydney",
        "countryOfBirth": "AU",
        "residenceCountryCode": "AU",
        "nationality": "AU",
        "maritalStatus": "MARRIED",
        "residencyStatus": "RENTED_HOUSE",
        "residenceType": "CONDOMINIUM",
        "secondOtherNationalityCountryCode": "SG",
        "thirdOtherNationalityCountryCode": "MY",
        "fourthOtherNationalityCountryCode": "TH",
        "fifthOtherNationalityCountryCode": "ID"
    },
    "addressList": {
        "addressKey": 1,
        "addressline1": "40A ORCHARD ROAD",
        "addressline2": "#99-99 MACDONALD HOUSE",
        "addressline3": "Orchard Avenue 2",
        "addressline4": "Street 65",
        "addressType": "PRIMARY_ADDRESS",
        "district": "Cairns",
        "city": "SINGAPORE",
        "state": "SINGAPORE",
        "postalCode": "520189",
        "countryName": "SINGAPORE",
        "countrySpecificAddress": {
            "village": "sentosa",
            "subDistrict": "keppel",
            "regencyCode": "7201     BL       KAB. BULELENG"
        }
    },
    "emails": {
        "emailKey": 1,
        "emailAddress": "javier123@yahoo.com",
        "preferredEmailFlag": "true",
        "emailType": "PERSONAL"
    },
    "phones": {
        "phoneKey": 1,
        "phoneType": "HOME",
        "phoneNumber": "4567234512",
        "phoneCountryCode": "34",
        "areaCode": "O",
        "extension": "O"
    },
    "identificationDocumentDetails": {
        "idType": "PASSPORT",
        "primaryIdFlag": true,
        "idNumber": "S42258011",
        "idExpiryDate": "2027-04-11",
        "idIssueDate": "2017-04-12",
        "idIssuePlace": "Brisbane",
        "idIssueCountry": "AU"
    },
    "educationDetails": {
        "highestEducationLevel": "MASTER"
    },
    "employmentDetails": {
        "employerName": "Citi Bank",
        "jobTitle": "ACCOUNTANT",
        "occupationCode": "ACCOUNTANT",
        "otherOccupationDescription": "Relationship Manager",
        "industryCode": "CITIBANK_SUB_NON_BANK",
        "employmentDurationInYears": 5,
        "emailAddress": "matt.hayden@abc.com",
        "employmentStatus": "RETIRED",
        "employmentStartDate": "2010-12-31"
    },
    "financialInformation": {
        "incomeDetails": {
            "incomeType": "DECLARED_FIXED",
            "fixedAmount": 5000.25,
            "variableAmount": 3500.25,
            "frequency": "MONTHLY"
        }
    },
    "kycInformation": {
        "usTaxStatus": "US_PERSON_REPORTABLE_DOCUMENTED",
        "usTaxId": "US234567",
        "usTaxIdCertificationDate": "2016-02-21",
        "nonResidentTaxCertificationStrtDate": "2016-02-21",
        "nonResidentTaxCertificationExpDate": "2018-02-21",
        "usResidencyStatus": "US_CITIZEN"
    }
}
400

TypeCodeDetails
invalidinvalidRequestMissing or invalid parameters
Definitions
  • type
    • Invalid - Request did not confirm to the specification and was unprocessed and rejected. Please fix the value and try again
    • enum : Array
    • type : string
  • code
    • Error code which qualifies the error
    • type : string
  • details
    • Human readable explanation specific to the occurrence of the problem
    • type : string
  • location
    • The name of the field that resulted in the error
    • type : string
  • moreInfo
    • URI to human readable documentation of the error
    • type : object
  • required
    • type
    • code
Response Schema for get /v1/customers/profiles
{
    "properties": {
        "type": {
            "description": "Invalid - Request did not confirm to the specification and was unprocessed and rejected. Please fix the value and try again",
            "enum": [
                "error",
                "warn",
                "invalid",
                "fatal"
            ],
            "type": "string"
        },
        "code": {
            "description": "Error code which qualifies the error",
            "type": "string"
        },
        "details": {
            "description": "Human readable explanation specific to the occurrence of the problem",
            "type": "string"
        },
        "location": {
            "description": "The name of the field that resulted in the error",
            "type": "string"
        },
        "moreInfo": {
            "description": "URI to human readable documentation of the error",
            "type": "object"
        }
    },
    "required": [
        "type",
        "code"
    ]
}
401

errorunAuthorizedAuthorization credentials are missing or invalid
Definitions
  • type
    • Invalid - Request did not confirm to the specification and was unprocessed and rejected. Please fix the value and try again
    • enum : Array
    • type : string
  • code
    • Error code which qualifies the error
    • type : string
  • details
    • Human readable explanation specific to the occurrence of the problem
    • type : string
  • location
    • The name of the field that resulted in the error
    • type : string
  • moreInfo
    • URI to human readable documentation of the error
    • type : object
  • required
    • type
    • code
Response Schema for get /v1/customers/profiles
{
    "properties": {
        "type": {
            "description": "Invalid - Request did not confirm to the specification and was unprocessed and rejected. Please fix the value and try again",
            "enum": [
                "error",
                "warn",
                "invalid",
                "fatal"
            ],
            "type": "string"
        },
        "code": {
            "description": "Error code which qualifies the error",
            "type": "string"
        },
        "details": {
            "description": "Human readable explanation specific to the occurrence of the problem",
            "type": "string"
        },
        "location": {
            "description": "The name of the field that resulted in the error",
            "type": "string"
        },
        "moreInfo": {
            "description": "URI to human readable documentation of the error",
            "type": "object"
        }
    },
    "required": [
        "type",
        "code"
    ]
}
403

erroraccessNotConfiguredAccess is not configured for this resource
Definitions
  • type
    • Invalid - Request did not confirm to the specification and was unprocessed and rejected. Please fix the value and try again
    • enum : Array
    • type : string
  • code
    • Error code which qualifies the error
    • type : string
  • details
    • Human readable explanation specific to the occurrence of the problem
    • type : string
  • location
    • The name of the field that resulted in the error
    • type : string
  • moreInfo
    • URI to human readable documentation of the error
    • type : object
  • required
    • type
    • code
Response Schema for get /v1/customers/profiles
{
    "properties": {
        "type": {
            "description": "Invalid - Request did not confirm to the specification and was unprocessed and rejected. Please fix the value and try again",
            "enum": [
                "error",
                "warn",
                "invalid",
                "fatal"
            ],
            "type": "string"
        },
        "code": {
            "description": "Error code which qualifies the error",
            "type": "string"
        },
        "details": {
            "description": "Human readable explanation specific to the occurrence of the problem",
            "type": "string"
        },
        "location": {
            "description": "The name of the field that resulted in the error",
            "type": "string"
        },
        "moreInfo": {
            "description": "URI to human readable documentation of the error",
            "type": "object"
        }
    },
    "required": [
        "type",
        "code"
    ]
}
404

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

fatalserverUnavailableThe request failed due to an internal error
Definitions
  • type
    • Invalid - Request did not confirm to the specification and was unprocessed and rejected. Please fix the value and try again
    • enum : Array
    • type : string
  • code
    • Error code which qualifies the error
    • type : string
  • details
    • Human readable explanation specific to the occurrence of the problem
    • type : string
  • location
    • The name of the field that resulted in the error
    • type : string
  • moreInfo
    • URI to human readable documentation of the error
    • type : object
  • required
    • type
    • code
Response Schema for get /v1/customers/profiles
{
    "properties": {
        "type": {
            "description": "Invalid - Request did not confirm to the specification and was unprocessed and rejected. Please fix the value and try again",
            "enum": [
                "error",
                "warn",
                "invalid",
                "fatal"
            ],
            "type": "string"
        },
        "code": {
            "description": "Error code which qualifies the error",
            "type": "string"
        },
        "details": {
            "description": "Human readable explanation specific to the occurrence of the problem",
            "type": "string"
        },
        "location": {
            "description": "The name of the field that resulted in the error",
            "type": "string"
        },
        "moreInfo": {
            "description": "URI to human readable documentation of the error",
            "type": "object"
        }
    },
    "required": [
        "type",
        "code"
    ]
}

Retrieve Customer Basic Name

get /v1/customers/profiles/basic
Description

Returns the Citi customer's name, including surname, prefix and suffix.

Header Parameters
Authorization
string required
The most recent Authorization token. This will have the format Bearer + {space} + {accessToken}. Example: Bearer KGNsaWVudF9pZDpjbGllbnRfc2VjcmV0KQ==.
uuid
string required
128 bit random UUID generated uniquely for every request.
Accept
string required
Content-Types that are acceptable for the response.
client_id
string required
Client ID generated during application registration.
  • cURL
  • Ruby
  • Python
  • PHP
  • Java
  • Node
  • Go
  • Swift

Example Request

Example Request

Example Request

Example Request

Example Request

Example Request

Example Request

Example Request

Responses
200

Successful operation.
Definitions
  • customerType
    • Type of the customer. This is applicable only for Individual customers.This is a reference data field. Please use /v1/apac/utilities/referenceData/{customerType} resource to get valid value of this field with description. You can use customerType as the referenceCode parameter to retrieve the values.
    • type : string
  • customerSegment
    • Type of the customer. This is applicable only for Individual customers.This is a reference data field. Please use /v1/apac/utilities/referenceData/{customerSegment} resource to get valid value of this field with description. You can use customerSegment as the referenceCode parameter to retrieve the values. Mandatory if partnerCustomerSegment is not present.
    • type : string
  • partnerCustomerSegment
    • Partner customer segment.This is a reference data field. Please use /v1/apac/utilities/referenceData/{partnerCustomerSegment} resource to get possible value of this field with description. Mandatory if customerSegment is not present.
    • type : string
  • customerParticulars
      • names
        • properties : Array
      • prefix
        • The prefix of the customer s name.
        • type : string
      • suffix
        • The suffix of the customer s name.
        • type : string
Example Response for get /v1/customers/profiles/basic
{
    "customerType": "INDIVIDUAL",
    "customerSegment": "BLUE",
    "partnerCustomerSegment": "AD1",
    "customerParticulars": {
        "names": {
            "firstName": "Javier",
            "lastName": "de Cuellar",
            "nameType": "LOCAL_NAME",
            "middleName": "Perez",
            "fullName": "Javier Perez de Cuellar"
        },
        "prefix": "Mr.",
        "suffix": "III"
    }
}
400

TypeCodeDetails
invalidinvalidRequestMissing or invalid Parameters
Definitions
  • type
    • Invalid - Request did not confirm to the specification and was unprocessed and rejected. Please fix the value and try again
    • enum : Array
    • type : string
  • code
    • Error code which qualifies the error
    • type : string
  • details
    • Human readable explanation specific to the occurrence of the problem
    • type : string
  • location
    • The name of the field that resulted in the error
    • type : string
  • moreInfo
    • URI to human readable documentation of the error
    • type : object
  • required
    • type
    • code
Response Schema for get /v1/customers/profiles/basic
{
    "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"
    ]
}
401

TypeCodeDetails
errorunAuthorizedAuthorization credential is missing or invalid
Definitions
  • type
    • Invalid - Request did not confirm to the specification and was unprocessed and rejected. Please fix the value and try again
    • enum : Array
    • type : string
  • code
    • Error code which qualifies the error
    • type : string
  • details
    • Human readable explanation specific to the occurrence of the problem
    • type : string
  • location
    • The name of the field that resulted in the error
    • type : string
  • moreInfo
    • URI to human readable documentation of the error
    • type : object
  • required
    • type
    • code
Response Schema for get /v1/customers/profiles/basic
{
    "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"
    ]
}
403

TypeCodeDetails
erroraccessNotConfiguredAccess is not configured for this resource
Definitions
  • type
    • Invalid - Request did not confirm to the specification and was unprocessed and rejected. Please fix the value and try again
    • enum : Array
    • type : string
  • code
    • Error code which qualifies the error
    • type : string
  • details
    • Human readable explanation specific to the occurrence of the problem
    • type : string
  • location
    • The name of the field that resulted in the error
    • type : string
  • moreInfo
    • URI to human readable documentation of the error
    • type : object
  • required
    • type
    • code
Response Schema for get /v1/customers/profiles/basic
{
    "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"
    ]
}
404

TypeCodeDetails
errorresourceNotFoundEmpty resource/resource not found
Definitions
  • type
    • Invalid - Request did not confirm to the specification and was unprocessed and rejected. Please fix the value and try again
    • enum : Array
    • type : string
  • code
    • Error code which qualifies the error
    • type : string
  • details
    • Human readable explanation specific to the occurrence of the problem
    • type : string
  • location
    • The name of the field that resulted in the error
    • type : string
  • moreInfo
    • URI to human readable documentation of the error
    • type : object
  • required
    • type
    • code
Response Schema for get /v1/customers/profiles/basic
{
    "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"
    ]
}
500

TypeCodeDetails
fatalserverUnavailableThe request failed due to an internal error
Definitions
  • type
    • Invalid - Request did not confirm to the specification and was unprocessed and rejected. Please fix the value and try again
    • enum : Array
    • type : string
  • code
    • Error code which qualifies the error
    • type : string
  • details
    • Human readable explanation specific to the occurrence of the problem
    • type : string
  • location
    • The name of the field that resulted in the error
    • type : string
  • moreInfo
    • URI to human readable documentation of the error
    • type : object
  • required
    • type
    • code
Response Schema for get /v1/customers/profiles/basic
{
    "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"
    ]
}