Utilities

Select the following:
Home

>

API Products

>

Hong Kong - Utilities API Documentation

Utilities

Want to try this API out on our Playground?

Go play now
Endpoints on this page
get /v1/utilities/metaData MetaData Inquiry
get /v1/apac/utilities/referenceData/{referenceCode} Retrieve Reference Data Values
get /v1/apac/utilities/addresses/{postalCode} Retrieve Address for Specific Postal Code
get /v1/compliance/sanctions/countries This API is used list the countries with sanction indicator.
get /v1/utilities/employers This API is to search for the employers details based on the employer search parameters

MetaData Inquiry

get /v1/utilities/metaData
Description

This API is used to retrieve the field properties and validations applied for a specific market.

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-Type that are acceptable for the response.
client_id
string required
Client ID generated during application registration.
Query Parameters
apiUri
string required
The URI for the target documentation. Example: /v1/apac/onboarding/products/unsecured/applications
apiMethod
string required
The HTTP method required to invoke this operation.
{
    "enum": [
        "GET",
        "POST",
        "PUT",
        "DELETE"
    ]
}
  • 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
  • requestElementDetails
      • jsonElementName
        • The name of the JSON element or path or query parameter used for describing the JSON property.
        • type : string
      • jsonDataType
        • The type of the json element.
        • enum : STRING, DOUBLE, INTEGER, BOOLEAN, OBJECT, DATE
        • type : string
      • elementLocation
        • The location of the parameter.
        • enum : QUERY, PATH, FORM_DATA, BODY
        • type : string
      • cvtReferenceDataKey
        • Reference data key name corresponding to the element. Applicable only for CVT fields
        • type : string
      • mandatoryIndicator
        • Determines whether this parameter is mandatory.
        • enum : MANDATORY, NON_MANDATORY, CONDITIONAL_MANDATORY, NOT_SUPPORTED
        • type : string
      • minimumOccurrence
        • Minimum number of occurrence if the json element is an array.
        • type : string
      • maximumOccurrence
        • Maximum number of occurrence if the json element is an array.
        • type : string
      • minimumLength
        • The minimum length for a string value
        • type : number
        • format : integer
      • maximumLength
        • The maximum length for a string value
        • type : number
        • format : integer
      • minimumRange
        • The minimum range for a number or date value
        • type : string
      • maximumRange
        • The maximum range for a number or date value
        • type : string
      • pattern
        • Describes a regular expression pattern for the field value.
        • type : string
      • additionalInformation
        • Any remarks or additional information related to the field.
        • type : string
  • responseElementDetails
      • jsonElementName
        • The name of the JSON element or path or query parameter used for describing the JSON property.
        • type : string
      • jsonDataType
        • The type of the json element.
        • enum : STRING, INTEGER, DOUBLE, BOOLEAN, OBJECT, DATE
        • type : string
      • cvtReferenceDataKey
        • Reference data key name corresponding to the element. Applicable only for CVT fields
        • type : string
      • mandatoryIndicator
        • Determines whether this parameter is mandatory.
        • enum : MANDATORY, NON_MANDATORY, CONDITIONAL_MANDATORY, NOT_SUPPORTED
        • type : string
      • minimumOccurrence
        • Minimum number of occurrence if the json element is an array.
        • type : string
      • maximumOccurrence
        • Maximum number of occurrence if the json element is an array.
        • type : string
      • minimumLength
        • The minimum length for a string value
        • type : number
        • format : integer
      • maximumLength
        • The maximum length for a string value
        • type : number
        • format : integer
      • minimumRange
        • The minimum range for a number or date value
        • type : string
      • maximumRange
        • The maximum range for a number or date value
        • type : string
      • pattern
        • Describes a regular expression pattern for the field value.
        • type : string
      • additionalInformation
        • Any remarks or additional information related to the field.
        • type : string
Example Response for get /v1/utilities/metaData
400

TypeCodeDetails
invalidinvalidRequestMissing or invalid Parameters
Definitions
  • type
    • type : string
    • enum : error, warn, invalid, fatal

    • invalid - Request did not confirm to the specification and was unprocessed & rejected. Please fix the value and try again

      warn - Request was partially processed. E.g. some of the fields are missing in response to the system issues, request was accepted successfully but will be processed asynchronously

      error - The request was accepted but could not be processed successfully

      fatal - There was an internal system error while processing the request. These are technical errors and will be resolved by Citi, and the consumer should retry after some time. Business errors will not be categorized as fatal
  • 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/utilities/metaData
{
    "properties": {
        "type": {
            "type": "string",
            "enum": [
                "error",
                "warn",
                "invalid",
                "fatal"
            ],
            "description": "
invalid - Request did not confirm to the specification and was unprocessed & rejected. Please fix the value and try again<\/br>
warn - Request was partially processed. E.g. some of the fields are missing in response to the system issues, request was accepted successfully but will be processed asynchronously<\/br>
error - The request was accepted but could not be processed successfully<\/br>
fatal - There was an internal system error while processing the request. These are technical errors and will be resolved by Citi, and the consumer should retry after some time. Business errors will not be categorized as fatal <\/br>" }, "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
    • type : string
    • enum : error, warn, invalid, fatal

    • invalid - Request did not confirm to the specification and was unprocessed & rejected. Please fix the value and try again

      warn - Request was partially processed. E.g. some of the fields are missing in response to the system issues, request was accepted successfully but will be processed asynchronously

      error - The request was accepted but could not be processed successfully

      fatal - There was an internal system error while processing the request. These are technical errors and will be resolved by Citi, and the consumer should retry after some time. Business errors will not be categorized as fatal
  • 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/utilities/metaData
{
    "properties": {
        "type": {
            "type": "string",
            "enum": [
                "error",
                "warn",
                "invalid",
                "fatal"
            ],
            "description": "
invalid - Request did not confirm to the specification and was unprocessed & rejected. Please fix the value and try again<\/br>
warn - Request was partially processed. E.g. some of the fields are missing in response to the system issues, request was accepted successfully but will be processed asynchronously<\/br>
error - The request was accepted but could not be processed successfully<\/br>
fatal - There was an internal system error while processing the request. These are technical errors and will be resolved by Citi, and the consumer should retry after some time. Business errors will not be categorized as fatal <\/br>" }, "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

erroraccessNotConfiguredThe request operation is not configured to access this resource
Definitions
  • type
    • type : string
    • enum : error, warn, invalid, fatal

    • invalid - Request did not confirm to the specification and was unprocessed & rejected. Please fix the value and try again

      warn - Request was partially processed. E.g. some of the fields are missing in response to the system issues, request was accepted successfully but will be processed asynchronously

      error - The request was accepted but could not be processed successfully

      fatal - There was an internal system error while processing the request. These are technical errors and will be resolved by Citi, and the consumer should retry after some time. Business errors will not be categorized as fatal
  • 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/utilities/metaData
{
    "properties": {
        "type": {
            "type": "string",
            "enum": [
                "error",
                "warn",
                "invalid",
                "fatal"
            ],
            "description": "
invalid - Request did not confirm to the specification and was unprocessed & rejected. Please fix the value and try again<\/br>
warn - Request was partially processed. E.g. some of the fields are missing in response to the system issues, request was accepted successfully but will be processed asynchronously<\/br>
error - The request was accepted but could not be processed successfully<\/br>
fatal - There was an internal system error while processing the request. These are technical errors and will be resolved by Citi, and the consumer should retry after some time. Business errors will not be categorized as fatal <\/br>" }, "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
    • type : string
    • enum : error, warn, invalid, fatal

    • invalid - Request did not confirm to the specification and was unprocessed & rejected. Please fix the value and try again

      warn - Request was partially processed. E.g. some of the fields are missing in response to the system issues, request was accepted successfully but will be processed asynchronously

      error - The request was accepted but could not be processed successfully

      fatal - There was an internal system error while processing the request. These are technical errors and will be resolved by Citi, and the consumer should retry after some time. Business errors will not be categorized as fatal
  • 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/utilities/metaData
{
    "properties": {
        "type": {
            "type": "string",
            "enum": [
                "error",
                "warn",
                "invalid",
                "fatal"
            ],
            "description": "
invalid - Request did not confirm to the specification and was unprocessed & rejected. Please fix the value and try again<\/br>
warn - Request was partially processed. E.g. some of the fields are missing in response to the system issues, request was accepted successfully but will be processed asynchronously<\/br>
error - The request was accepted but could not be processed successfully<\/br>
fatal - There was an internal system error while processing the request. These are technical errors and will be resolved by Citi, and the consumer should retry after some time. Business errors will not be categorized as fatal <\/br>" }, "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

fatal serverUnavailableThe request failed due to an internal error
Definitions
  • type
    • type : string
    • enum : error, warn, invalid, fatal

    • invalid - Request did not confirm to the specification and was unprocessed & rejected. Please fix the value and try again

      warn - Request was partially processed. E.g. some of the fields are missing in response to the system issues, request was accepted successfully but will be processed asynchronously

      error - The request was accepted but could not be processed successfully

      fatal - There was an internal system error while processing the request. These are technical errors and will be resolved by Citi, and the consumer should retry after some time. Business errors will not be categorized as fatal
  • 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/utilities/metaData
{
    "properties": {
        "type": {
            "type": "string",
            "enum": [
                "error",
                "warn",
                "invalid",
                "fatal"
            ],
            "description": "
invalid - Request did not confirm to the specification and was unprocessed & rejected. Please fix the value and try again<\/br>
warn - Request was partially processed. E.g. some of the fields are missing in response to the system issues, request was accepted successfully but will be processed asynchronously<\/br>
error - The request was accepted but could not be processed successfully<\/br>
fatal - There was an internal system error while processing the request. These are technical errors and will be resolved by Citi, and the consumer should retry after some time. Business errors will not be categorized as fatal <\/br>" }, "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 Reference Data Values

get /v1/apac/utilities/referenceData/{referenceCode}
Description

This API is used to retrieve an array of valid values and descriptions for the specified field.

Path Parameters
referenceCode
string required
Reference Code
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-Type 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
  • referenceDataDetails
      • referenceDataCode
        • Reference data code associated with CVT
        • type : string
      • referenceDataValue
        • Reference data Value associated with CVT
        • type : string
      • referenceDataShortDescription
        • Reference data Short description associated with CVT
        • type : string
      • referenceDataLongDescription
        • Reference data long description associated with CVT
        • type : string
      • status
        • Reference data status
        • type : string
Example Response for get /v1/apac/utilities/referenceData/{referenceCode}
400

TypeCodeDetails
invalidinvalidRequestMissing or invalid parameters
Definitions
  • type
    • type : string
    • enum : error, warn, invalid, fatal

    • invalid - Request did not confirm to the specification and was unprocessed & rejected. Please fix the value and try again

      warn - Request was partially processed. E.g. some of the fields are missing in response to the system issues, request was accepted successfully but will be processed asynchronously

      error - The request was accepted but could not be processed successfully

      fatal - There was an internal system error while processing the request. These are technical errors and will be resolved by Citi, and the consumer should retry after some time. Business errors will not be categorized as fatal
  • 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/apac/utilities/referenceData/{referenceCode}
{
    "properties": {
        "type": {
            "type": "string",
            "enum": [
                "error",
                "warn",
                "invalid",
                "fatal"
            ],
            "description": "
invalid - Request did not confirm to the specification and was unprocessed & rejected. Please fix the value and try again<\/br>
warn - Request was partially processed. E.g. some of the fields are missing in response to the system issues, request was accepted successfully but will be processed asynchronously<\/br>
error - The request was accepted but could not be processed successfully<\/br>
fatal - There was an internal system error while processing the request. These are technical errors and will be resolved by Citi, and the consumer should retry after some time. Business errors will not be categorized as fatal <\/br>" }, "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
    • type : string
    • enum : error, warn, invalid, fatal

    • invalid - Request did not confirm to the specification and was unprocessed & rejected. Please fix the value and try again

      warn - Request was partially processed. E.g. some of the fields are missing in response to the system issues, request was accepted successfully but will be processed asynchronously

      error - The request was accepted but could not be processed successfully

      fatal - There was an internal system error while processing the request. These are technical errors and will be resolved by Citi, and the consumer should retry after some time. Business errors will not be categorized as fatal
  • 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/apac/utilities/referenceData/{referenceCode}
{
    "properties": {
        "type": {
            "type": "string",
            "enum": [
                "error",
                "warn",
                "invalid",
                "fatal"
            ],
            "description": "
invalid - Request did not confirm to the specification and was unprocessed & rejected. Please fix the value and try again<\/br>
warn - Request was partially processed. E.g. some of the fields are missing in response to the system issues, request was accepted successfully but will be processed asynchronously<\/br>
error - The request was accepted but could not be processed successfully<\/br>
fatal - There was an internal system error while processing the request. These are technical errors and will be resolved by Citi, and the consumer should retry after some time. Business errors will not be categorized as fatal <\/br>" }, "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

erroraccessNotConfiguredThe requested operation is not configured to access this resource.Channel/Country/Business provided in the request is not supported currently
Definitions
  • type
    • type : string
    • enum : error, warn, invalid, fatal

    • invalid - Request did not confirm to the specification and was unprocessed & rejected. Please fix the value and try again

      warn - Request was partially processed. E.g. some of the fields are missing in response to the system issues, request was accepted successfully but will be processed asynchronously

      error - The request was accepted but could not be processed successfully

      fatal - There was an internal system error while processing the request. These are technical errors and will be resolved by Citi, and the consumer should retry after some time. Business errors will not be categorized as fatal
  • 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/apac/utilities/referenceData/{referenceCode}
{
    "properties": {
        "type": {
            "type": "string",
            "enum": [
                "error",
                "warn",
                "invalid",
                "fatal"
            ],
            "description": "
invalid - Request did not confirm to the specification and was unprocessed & rejected. Please fix the value and try again<\/br>
warn - Request was partially processed. E.g. some of the fields are missing in response to the system issues, request was accepted successfully but will be processed asynchronously<\/br>
error - The request was accepted but could not be processed successfully<\/br>
fatal - There was an internal system error while processing the request. These are technical errors and will be resolved by Citi, and the consumer should retry after some time. Business errors will not be categorized as fatal <\/br>" }, "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
    • type : string
    • enum : error, warn, invalid, fatal

    • invalid - Request did not confirm to the specification and was unprocessed & rejected. Please fix the value and try again

      warn - Request was partially processed. E.g. some of the fields are missing in response to the system issues, request was accepted successfully but will be processed asynchronously

      error - The request was accepted but could not be processed successfully

      fatal - There was an internal system error while processing the request. These are technical errors and will be resolved by Citi, and the consumer should retry after some time. Business errors will not be categorized as fatal
  • 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/apac/utilities/referenceData/{referenceCode}
{
    "properties": {
        "type": {
            "type": "string",
            "enum": [
                "error",
                "warn",
                "invalid",
                "fatal"
            ],
            "description": "
invalid - Request did not confirm to the specification and was unprocessed & rejected. Please fix the value and try again<\/br>
warn - Request was partially processed. E.g. some of the fields are missing in response to the system issues, request was accepted successfully but will be processed asynchronously<\/br>
error - The request was accepted but could not be processed successfully<\/br>
fatal - There was an internal system error while processing the request. These are technical errors and will be resolved by Citi, and the consumer should retry after some time. Business errors will not be categorized as fatal <\/br>" }, "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
    • type : string
    • enum : error, warn, invalid, fatal

    • invalid - Request did not confirm to the specification and was unprocessed & rejected. Please fix the value and try again

      warn - Request was partially processed. E.g. some of the fields are missing in response to the system issues, request was accepted successfully but will be processed asynchronously

      error - The request was accepted but could not be processed successfully

      fatal - There was an internal system error while processing the request. These are technical errors and will be resolved by Citi, and the consumer should retry after some time. Business errors will not be categorized as fatal
  • 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/apac/utilities/referenceData/{referenceCode}
{
    "properties": {
        "type": {
            "type": "string",
            "enum": [
                "error",
                "warn",
                "invalid",
                "fatal"
            ],
            "description": "
invalid - Request did not confirm to the specification and was unprocessed & rejected. Please fix the value and try again<\/br>
warn - Request was partially processed. E.g. some of the fields are missing in response to the system issues, request was accepted successfully but will be processed asynchronously<\/br>
error - The request was accepted but could not be processed successfully<\/br>
fatal - There was an internal system error while processing the request. These are technical errors and will be resolved by Citi, and the consumer should retry after some time. Business errors will not be categorized as fatal <\/br>" }, "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 Address for Specific Postal Code

get /v1/apac/utilities/addresses/{postalCode}
Description

This API is used to retrieve the address parameters for the specified postal code. It can be used to either validate addresses or populate address fields.

Path Parameters
postalCode
string required
Postal Code
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-Type 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

The request has succeeded
Definitions
  • addressSearchDetails
      • addressLine1
        • Address line 1
        • type : string
      • addressLine2
        • Address line 2
        • type : string
      • addressLine3
        • Address line 3
        • type : string
      • addressLine4
        • Address line 4
        • type : string
      • cityName
        • City
        • type : string
      • state
        • State
        • type : string
      • postalCode
        • Postal/ZIP code
        • type : string
      • provinceCode
        • Province code
        • type : string
      • countryCode
        • ISO country code. This is a reference data field. Please use /utilities/referenceData/{country} resource to get possible values of this field with descriptions. You can use the field name as the referenceCode parameter to retrieve the values.
        • type : string
      • unitNumber
        • Unit Number
        • type : string
      • floorNumber
        • Floor Number
        • type : string
      • blockNumber
        • Block Number
        • type : string
      • buildingName
        • Building Name
        • type : string
      • estateName
        • Estate Name
        • type : string
      • streetNumber
        • Street Number
        • type : string
      • streetName
        • Street Name
        • type : string
      • streetType
        • Street Type
        • type : string
      • town
        • Town
        • type : string
Example Response for get /v1/apac/utilities/addresses/{postalCode}
400

TypeCodeDetails
invalidinvalidRequestMissing or invalid parameters
errorinvalidPostalCodeMissing or invalid PostalCode
Definitions
  • type
    • type : string
    • enum : error, warn, invalid, fatal

    • invalid - Request did not confirm to the specification and was unprocessed & rejected. Please fix the value and try again

      warn - Request was partially processed. E.g. some of the fields are missing in response to the system issues, request was accepted successfully but will be processed asynchronously

      error - The request was accepted but could not be processed successfully

      fatal - There was an internal system error while processing the request. These are technical errors and will be resolved by Citi, and the consumer should retry after some time. Business errors will not be categorized as fatal
  • 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/apac/utilities/addresses/{postalCode}
{
    "properties": {
        "type": {
            "type": "string",
            "enum": [
                "error",
                "warn",
                "invalid",
                "fatal"
            ],
            "description": "
invalid - Request did not confirm to the specification and was unprocessed & rejected. Please fix the value and try again<\/br>
warn - Request was partially processed. E.g. some of the fields are missing in response to the system issues, request was accepted successfully but will be processed asynchronously<\/br>
error - The request was accepted but could not be processed successfully<\/br>
fatal - There was an internal system error while processing the request. These are technical errors and will be resolved by Citi, and the consumer should retry after some time. Business errors will not be categorized as fatal <\/br>" }, "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
    • type : string
    • enum : error, warn, invalid, fatal

    • invalid - Request did not confirm to the specification and was unprocessed & rejected. Please fix the value and try again

      warn - Request was partially processed. E.g. some of the fields are missing in response to the system issues, request was accepted successfully but will be processed asynchronously

      error - The request was accepted but could not be processed successfully

      fatal - There was an internal system error while processing the request. These are technical errors and will be resolved by Citi, and the consumer should retry after some time. Business errors will not be categorized as fatal
  • 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/apac/utilities/addresses/{postalCode}
{
    "properties": {
        "type": {
            "type": "string",
            "enum": [
                "error",
                "warn",
                "invalid",
                "fatal"
            ],
            "description": "
invalid - Request did not confirm to the specification and was unprocessed & rejected. Please fix the value and try again<\/br>
warn - Request was partially processed. E.g. some of the fields are missing in response to the system issues, request was accepted successfully but will be processed asynchronously<\/br>
error - The request was accepted but could not be processed successfully<\/br>
fatal - There was an internal system error while processing the request. These are technical errors and will be resolved by Citi, and the consumer should retry after some time. Business errors will not be categorized as fatal <\/br>" }, "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

invalidaccessNotConfiguredThe request operation is not configured to access this resource.Channel/Country/Business provided in the request is not supported currently
Definitions
  • type
    • type : string
    • enum : error, warn, invalid, fatal

    • invalid - Request did not confirm to the specification and was unprocessed & rejected. Please fix the value and try again

      warn - Request was partially processed. E.g. some of the fields are missing in response to the system issues, request was accepted successfully but will be processed asynchronously

      error - The request was accepted but could not be processed successfully

      fatal - There was an internal system error while processing the request. These are technical errors and will be resolved by Citi, and the consumer should retry after some time. Business errors will not be categorized as fatal
  • 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/apac/utilities/addresses/{postalCode}
{
    "properties": {
        "type": {
            "type": "string",
            "enum": [
                "error",
                "warn",
                "invalid",
                "fatal"
            ],
            "description": "
invalid - Request did not confirm to the specification and was unprocessed & rejected. Please fix the value and try again<\/br>
warn - Request was partially processed. E.g. some of the fields are missing in response to the system issues, request was accepted successfully but will be processed asynchronously<\/br>
error - The request was accepted but could not be processed successfully<\/br>
fatal - There was an internal system error while processing the request. These are technical errors and will be resolved by Citi, and the consumer should retry after some time. Business errors will not be categorized as fatal <\/br>" }, "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
    • type : string
    • enum : error, warn, invalid, fatal

    • invalid - Request did not confirm to the specification and was unprocessed & rejected. Please fix the value and try again

      warn - Request was partially processed. E.g. some of the fields are missing in response to the system issues, request was accepted successfully but will be processed asynchronously

      error - The request was accepted but could not be processed successfully

      fatal - There was an internal system error while processing the request. These are technical errors and will be resolved by Citi, and the consumer should retry after some time. Business errors will not be categorized as fatal
  • 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/apac/utilities/addresses/{postalCode}
{
    "properties": {
        "type": {
            "type": "string",
            "enum": [
                "error",
                "warn",
                "invalid",
                "fatal"
            ],
            "description": "
invalid - Request did not confirm to the specification and was unprocessed & rejected. Please fix the value and try again<\/br>
warn - Request was partially processed. E.g. some of the fields are missing in response to the system issues, request was accepted successfully but will be processed asynchronously<\/br>
error - The request was accepted but could not be processed successfully<\/br>
fatal - There was an internal system error while processing the request. These are technical errors and will be resolved by Citi, and the consumer should retry after some time. Business errors will not be categorized as fatal <\/br>" }, "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/server unavailability
Definitions
  • type
    • type : string
    • enum : error, warn, invalid, fatal

    • invalid - Request did not confirm to the specification and was unprocessed & rejected. Please fix the value and try again

      warn - Request was partially processed. E.g. some of the fields are missing in response to the system issues, request was accepted successfully but will be processed asynchronously

      error - The request was accepted but could not be processed successfully

      fatal - There was an internal system error while processing the request. These are technical errors and will be resolved by Citi, and the consumer should retry after some time. Business errors will not be categorized as fatal
  • 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/apac/utilities/addresses/{postalCode}
{
    "properties": {
        "type": {
            "type": "string",
            "enum": [
                "error",
                "warn",
                "invalid",
                "fatal"
            ],
            "description": "
invalid - Request did not confirm to the specification and was unprocessed & rejected. Please fix the value and try again<\/br>
warn - Request was partially processed. E.g. some of the fields are missing in response to the system issues, request was accepted successfully but will be processed asynchronously<\/br>
error - The request was accepted but could not be processed successfully<\/br>
fatal - There was an internal system error while processing the request. These are technical errors and will be resolved by Citi, and the consumer should retry after some time. Business errors will not be categorized as fatal <\/br>" }, "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" ] }

This API is used list the countries with sanction indicator.

get /v1/compliance/sanctions/countries
Description

This API is used list the countries with sanction indicator.

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-Type that are acceptable for the response.
client_id
string required
client id generated during consumer on-boarding
Accept-Language
string Optional
List of acceptable human languages for response.
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
  • 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
  • sanctionCountry
      • countryCode
        • ISO 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
      • countryName
        • This field is to indicate the name of the country.
        • type : string
Example Response for get /v1/compliance/sanctions/countries
204

No Content
This operation returns no content.
400

TypeCodeDetails
invalidinvalidRequestMissing or invalid parameters
Definitions
  • type
    • type : string
    • enum : error, warn, invalid, fatal

    • invalid - Request did not confirm to the specification and was unprocessed & rejected. Please fix the value and try again

      warn - Request was partially processed. E.g. some of the fields are missing in response to the system issues, request was accepted successfully but will be processed asynchronously

      error - The request was accepted but could not be processed successfully

      fatal - There was an internal system error while processing the request. These are technical errors and will be resolved by Citi, and the consumer should retry after some time. Business errors will not be categorized as fatal
  • 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/compliance/sanctions/countries
{
    "properties": {
        "type": {
            "type": "string",
            "enum": [
                "error",
                "warn",
                "invalid",
                "fatal"
            ],
            "description": "
invalid - Request did not confirm to the specification and was unprocessed & rejected. Please fix the value and try again<\/br>
warn - Request was partially processed. E.g. some of the fields are missing in response to the system issues, request was accepted successfully but will be processed asynchronously<\/br>
error - The request was accepted but could not be processed successfully<\/br>
fatal - There was an internal system error while processing the request. These are technical errors and will be resolved by Citi, and the consumer should retry after some time. Business errors will not be categorized as fatal <\/br>" }, "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
    • type : string
    • enum : error, warn, invalid, fatal

    • invalid - Request did not confirm to the specification and was unprocessed & rejected. Please fix the value and try again

      warn - Request was partially processed. E.g. some of the fields are missing in response to the system issues, request was accepted successfully but will be processed asynchronously

      error - The request was accepted but could not be processed successfully

      fatal - There was an internal system error while processing the request. These are technical errors and will be resolved by Citi, and the consumer should retry after some time. Business errors will not be categorized as fatal
  • 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/compliance/sanctions/countries
{
    "properties": {
        "type": {
            "type": "string",
            "enum": [
                "error",
                "warn",
                "invalid",
                "fatal"
            ],
            "description": "
invalid - Request did not confirm to the specification and was unprocessed & rejected. Please fix the value and try again<\/br>
warn - Request was partially processed. E.g. some of the fields are missing in response to the system issues, request was accepted successfully but will be processed asynchronously<\/br>
error - The request was accepted but could not be processed successfully<\/br>
fatal - There was an internal system error while processing the request. These are technical errors and will be resolved by Citi, and the consumer should retry after some time. Business errors will not be categorized as fatal <\/br>" }, "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
    • type : string
    • enum : error, warn, invalid, fatal

    • invalid - Request did not confirm to the specification and was unprocessed & rejected. Please fix the value and try again

      warn - Request was partially processed. E.g. some of the fields are missing in response to the system issues, request was accepted successfully but will be processed asynchronously

      error - The request was accepted but could not be processed successfully

      fatal - There was an internal system error while processing the request. These are technical errors and will be resolved by Citi, and the consumer should retry after some time. Business errors will not be categorized as fatal
  • 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/compliance/sanctions/countries
{
    "properties": {
        "type": {
            "type": "string",
            "enum": [
                "error",
                "warn",
                "invalid",
                "fatal"
            ],
            "description": "
invalid - Request did not confirm to the specification and was unprocessed & rejected. Please fix the value and try again<\/br>
warn - Request was partially processed. E.g. some of the fields are missing in response to the system issues, request was accepted successfully but will be processed asynchronously<\/br>
error - The request was accepted but could not be processed successfully<\/br>
fatal - There was an internal system error while processing the request. These are technical errors and will be resolved by Citi, and the consumer should retry after some time. Business errors will not be categorized as fatal <\/br>" }, "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
    • type : string
    • enum : error, warn, invalid, fatal

    • invalid - Request did not confirm to the specification and was unprocessed & rejected. Please fix the value and try again

      warn - Request was partially processed. E.g. some of the fields are missing in response to the system issues, request was accepted successfully but will be processed asynchronously

      error - The request was accepted but could not be processed successfully

      fatal - There was an internal system error while processing the request. These are technical errors and will be resolved by Citi, and the consumer should retry after some time. Business errors will not be categorized as fatal
  • 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/compliance/sanctions/countries
{
    "properties": {
        "type": {
            "type": "string",
            "enum": [
                "error",
                "warn",
                "invalid",
                "fatal"
            ],
            "description": "
invalid - Request did not confirm to the specification and was unprocessed & rejected. Please fix the value and try again<\/br>
warn - Request was partially processed. E.g. some of the fields are missing in response to the system issues, request was accepted successfully but will be processed asynchronously<\/br>
error - The request was accepted but could not be processed successfully<\/br>
fatal - There was an internal system error while processing the request. These are technical errors and will be resolved by Citi, and the consumer should retry after some time. Business errors will not be categorized as fatal <\/br>" }, "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" ] }

This API is to search for the employers details based on the employer search parameters

get /v1/utilities/employers
Description

This API is to search for the employers details based on the employer search parameters

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-Type that are acceptable for the response.
client_id
string required
Client ID generated during application registration.
Accept-Language
string Optional
List of acceptable human languages for response
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
employerName
string required
Employer Name. Minimum 4 characters to be sent to get list of matching employers
nextStartIndex
string Optional
The next start index that indicates the next set of records to be fetched, if there are available. Typically, this value should be populated if the first response has the value of nextStartIndex.It is not applicable for the first iteration.
  • 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
  • employersDetails
      • employerName
        • Employer Name
        • type : string
  • nextStartIndex
    • type : string
    • The next start index that indicates the next set of records to be fetched, if there are available. Typically, this value should be populated if the first response has the value of nextStartIndex.
Example Response for get /v1/utilities/employers
204

No Content
This operation returns no content.
400

invalidinvalidRequestMissing or invalid parameters
Definitions
  • type
    • type : string
    • enum : error, warn, invalid, fatal

    • invalid - Request did not confirm to the specification and was unprocessed & rejected. Please fix the value and try again

      warn - Request was partially processed. E.g. some of the fields are missing in response to the system issues, request was accepted successfully but will be processed asynchronously

      error - The request was accepted but could not be processed successfully

      fatal - There was an internal system error while processing the request. These are technical errors and will be resolved by Citi, and the consumer should retry after some time. Business errors will not be categorized as fatal
  • 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/utilities/employers
{
    "properties": {
        "type": {
            "type": "string",
            "enum": [
                "error",
                "warn",
                "invalid",
                "fatal"
            ],
            "description": "
invalid - Request did not confirm to the specification and was unprocessed & rejected. Please fix the value and try again<\/br>
warn - Request was partially processed. E.g. some of the fields are missing in response to the system issues, request was accepted successfully but will be processed asynchronously<\/br>
error - The request was accepted but could not be processed successfully<\/br>
fatal - There was an internal system error while processing the request. These are technical errors and will be resolved by Citi, and the consumer should retry after some time. Business errors will not be categorized as fatal <\/br>" }, "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
    • type : string
    • enum : error, warn, invalid, fatal

    • invalid - Request did not confirm to the specification and was unprocessed & rejected. Please fix the value and try again

      warn - Request was partially processed. E.g. some of the fields are missing in response to the system issues, request was accepted successfully but will be processed asynchronously

      error - The request was accepted but could not be processed successfully

      fatal - There was an internal system error while processing the request. These are technical errors and will be resolved by Citi, and the consumer should retry after some time. Business errors will not be categorized as fatal
  • 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/utilities/employers
{
    "properties": {
        "type": {
            "type": "string",
            "enum": [
                "error",
                "warn",
                "invalid",
                "fatal"
            ],
            "description": "
invalid - Request did not confirm to the specification and was unprocessed & rejected. Please fix the value and try again<\/br>
warn - Request was partially processed. E.g. some of the fields are missing in response to the system issues, request was accepted successfully but will be processed asynchronously<\/br>
error - The request was accepted but could not be processed successfully<\/br>
fatal - There was an internal system error while processing the request. These are technical errors and will be resolved by Citi, and the consumer should retry after some time. Business errors will not be categorized as fatal <\/br>" }, "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

erroraccessNotConfiguredThe request operation is not configured to access this resource
Definitions
  • type
    • type : string
    • enum : error, warn, invalid, fatal

    • invalid - Request did not confirm to the specification and was unprocessed & rejected. Please fix the value and try again

      warn - Request was partially processed. E.g. some of the fields are missing in response to the system issues, request was accepted successfully but will be processed asynchronously

      error - The request was accepted but could not be processed successfully

      fatal - There was an internal system error while processing the request. These are technical errors and will be resolved by Citi, and the consumer should retry after some time. Business errors will not be categorized as fatal
  • 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/utilities/employers
{
    "properties": {
        "type": {
            "type": "string",
            "enum": [
                "error",
                "warn",
                "invalid",
                "fatal"
            ],
            "description": "
invalid - Request did not confirm to the specification and was unprocessed & rejected. Please fix the value and try again<\/br>
warn - Request was partially processed. E.g. some of the fields are missing in response to the system issues, request was accepted successfully but will be processed asynchronously<\/br>
error - The request was accepted but could not be processed successfully<\/br>
fatal - There was an internal system error while processing the request. These are technical errors and will be resolved by Citi, and the consumer should retry after some time. Business errors will not be categorized as fatal <\/br>" }, "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
    • type : string
    • enum : error, warn, invalid, fatal

    • invalid - Request did not confirm to the specification and was unprocessed & rejected. Please fix the value and try again

      warn - Request was partially processed. E.g. some of the fields are missing in response to the system issues, request was accepted successfully but will be processed asynchronously

      error - The request was accepted but could not be processed successfully

      fatal - There was an internal system error while processing the request. These are technical errors and will be resolved by Citi, and the consumer should retry after some time. Business errors will not be categorized as fatal
  • 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/utilities/employers
{
    "properties": {
        "type": {
            "type": "string",
            "enum": [
                "error",
                "warn",
                "invalid",
                "fatal"
            ],
            "description": "
invalid - Request did not confirm to the specification and was unprocessed & rejected. Please fix the value and try again<\/br>
warn - Request was partially processed. E.g. some of the fields are missing in response to the system issues, request was accepted successfully but will be processed asynchronously<\/br>
error - The request was accepted but could not be processed successfully<\/br>
fatal - There was an internal system error while processing the request. These are technical errors and will be resolved by Citi, and the consumer should retry after some time. Business errors will not be categorized as fatal <\/br>" }, "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" ] }