--- swagger: "2.0" info: description: The Utilities APIs allow you to retrieve an array of valid values, field properties and validations applied for a specific market. This simplifies multimarket app development and helps to identify country-specific variations. title: Utilities version: 1.0.0g x-ibm-name: utilities_100g name: "" basePath: /api schemes: - https x-ibm-configuration: enforced: true phase: realized testable: true tags: [] definitions: ReferenceData: properties: referenceDataCode: description: Reference data code associated with CVT type: string example: title referenceDataValue: description: Reference data Value associated with CVT type: string example: MR referenceDataShortDescription: description: Reference data Short description associated with CVT type: string example: MR referenceDataLongDescription: description: Reference data long description associated with CVT type: string example: MISTER status: description: Reference data status type: string example: active required: - referenceDataCode - referenceDataValue ReferenceDataTypeResponse: properties: referenceDataDetails: items: type: string $ref: '#/definitions/ReferenceData' type: array KladrAddressSearchResponse: properties: kladrAddress: type: array items: $ref: '#/definitions/KladrAddress' KladrAddress: properties: houseNumber: description: House Number type: string streetName: description: Street name type: string streetNumber: description: Street number type: string streetType: description: Street Type type: string town: description: Town Name type: string cityName: description: City of address type: string districtName: description: District Name type: string regionCode: description: Indicates the region name. type: string postalCode: description: Zip code or postal code of the area. type: string coverageAreaCode: description: Coverage area code. type: string kladrCode: description: High level kladr code. KLADR refers to Russian postal address database. type: string ErrorList: properties: errors: type: array description: List of one or more errors items: $ref: '#/definitions/ErrorResponse' EmployersSearchResponse: properties: employersDetails: type: array items: $ref: '#/definitions/EmployerDetail' EmployerDetail: properties: employerName: description: Employer Name type: string example: CITI employerRegistrationNumber: description: Employer Registration number type: string example: "1027700035769" employerTaxRegistrationNumber: description: Employer tax registration number type: string example: "7708004767" employerAddressDetail: $ref: '#/definitions/EmployerAddressDetail' EmployerAddressDetail: description: Employer's address details properties: addressLine1: description: Address line 1 of the employer type: string example: 8-10 biuld. 1 addressLine2: description: Address line 2 of the employer type: string example: Gasheka Street addressLine3: description: Address line 3 of the employer type: string example: Gasheka Street addressLine4: description: Address line 4 of the employer type: string example: Gasheka Street cityName: description: City name of the employer type: string example: Moscow districtName: description: District name of the employer. type: string example: Giaginsky District state: description: State name of the employer. type: string example: Russia provinceCode: description: Province code of the employer.This a reference data field. Please use /utilities/referenceData/{provinceCode} resource to get valid values of this field with descriptions. You can use the fieldname as the referenceCode parameter to retrieve the values. type: string example: Moscow postalCode: description: Postal/ZIP code of the employer type: string example: "125047" RequestElementDetails: properties: jsonElementName: description: The name of the JSON element or path or query parameter used for describing the JSON property. type: string example: applicantId jsonDataType: description: The type of the json element. enum: - STRING - DOUBLE - INTEGER - BOOLEAN - OBJECT - DATE type: string example: string elementLocation: description: The location of the parameter. enum: - QUERY - PATH - FORM_DATA - BODY type: string example: BODY cvtReferenceDataKey: description: Reference data key name corresponding to the element. Applicable only for CVT fields type: string example: NOT APPLICABLE mandatoryIndicator: description: Determines whether this parameter is mandatory. enum: - MANDATORY - NON_MANDATORY - CONDITIONAL_MANDATORY - NOT_SUPPORTED type: string example: NOT_MANDATORY minimumOccurrence: description: Minimum number of occurrence if the json element is an array. type: string example: "1" maximumOccurrence: description: Maximum number of occurrence if the json element is an array. type: string example: "1" minimumLength: description: The minimum length for a string value type: number format: integer example: 10 maximumLength: description: The maximum length for a string value type: number format: integer example: 25 minimumRange: description: The minimum range for a number or date value type: string example: "1900-01-01" maximumRange: description: The maximum range for a number or date value type: string example: "2010-01-01" pattern: description: Describes a regular expression pattern for the field value. type: string example: '[A-Za-z0-9_]' additionalInformation: description: Any remarks or additional information related to the field. type: string example: Not Applicable required: - jsonElementName - jsonDataType - elementLocation - mandatoryIndicator ResponseElementDetails: properties: jsonElementName: description: The name of the JSON element or path or query parameter used for describing the JSON property. type: string example: dateOfBirth jsonDataType: description: The type of the json element. enum: - STRING - INTEGER - DOUBLE - BOOLEAN - OBJECT - DATE type: string example: date cvtReferenceDataKey: description: Reference data key name corresponding to the element. Applicable only for CVT fields type: string example: NOT APPLICABLE mandatoryIndicator: description: Determines whether this parameter is mandatory. enum: - MANDATORY - NON_MANDATORY - CONDITIONAL_MANDATORY - NOT_SUPPORTED type: string example: MANDATORY minimumOccurrence: description: Minimum number of occurrence if the json element is an array. type: string example: "1" maximumOccurrence: description: Maximum number of occurrence if the json element is an array. type: string example: "1" minimumLength: description: The minimum length for a string value type: number format: integer example: 10 maximumLength: description: The maximum length for a string value type: number format: integer example: 10 minimumRange: description: The minimum range for a number or date value type: string example: "1900-01-01" maximumRange: description: The maximum range for a number or date value type: string example: "2010-01-01" pattern: description: Describes a regular expression pattern for the field value. type: string example: '[A-Za-z0-9_]' additionalInformation: description: Any remarks or additional information related to the field. type: string example: NOT APPLICABLE required: - jsonElementName - jsonDataType - mandatoryIndicator ErrorResponse: properties: type: description: Invalid - Request did not confirm to the specification and was unprocessed and rejected. Please fix the value and try again enum: - error - warn - invalid - fatal type: string code: description: Error code which qualifies the error type: string details: description: Human readable explanation specific to the occurrence of the problem type: string location: description: The name of the field that resulted in the error type: string moreInfo: description: URI to human readable documentation of the error type: object required: - type - code securityDefinitions: Client_id: type: apiKey name: X-IBM-Client-Id in: header description: pv52735 paths: /v1/emea/utilities/employers: get: summary: Retrieve Employers Details description: This API is used to retrieve an array of valid values, field properties and validations applied for a specific market. tags: - EmployersSearch parameters: - name: client_id in: header description: The client ID you received while Onboarding with Citi to use these API's. This will be generated and shared while registring in the developer portal. type: string required: true - name: Authorization in: header description: The Authorization Token type: string required: true - name: uuid in: header description: 128 bit UUID that you generate for every request type: string required: true - name: Accept in: header description: Content-Types that are acceptable for the response. Currently we support application/json. type: string required: true - name: Accept-Language in: header description: List of acceptable human languages for response type: string required: false - name: Content-Type in: header description: The media type of the body of the request (used with POST and PUT requests). Currently we support application/json type: string required: true - name: clientDetails in: header description: Device and browser information. Refer the developer portal for more information. Please ensure the header is base64 encoded type: string required: false - name: employerName in: query description: Employer name type: string required: false - name: employerRegistrationNumber in: query description: Employer Registration number type: string required: false - name: employerTaxRegistrationNumber in: query description: Employer tax registration number type: string required: false responses: 200: description: Successful operation. schema: $ref: '#/definitions/EmployersSearchResponse' 400: description:
TypeCodeDetails
invalidinvalidRequestMissing or invalid Parameters
schema: $ref: '#/definitions/ErrorList' 401: description:
TypeCodeDetails
errorunAuthorizedAuthorization credentials are missing or invalid
schema: $ref: '#/definitions/ErrorList' 500: description:
TypeCodeDetails
fatalserverUnavailableThe request failed due to an internal error
schema: $ref: '#/definitions/ErrorList' /v1/ru/utilities/addresses: get: summary: Kladr Address Search description: This API is used to retrieve address from KLADR System based on search parameters. tags: [] parameters: - name: client_id in: header description: The client ID you received while Onboarding with Citi to use these API's. This will be generated and shared while registring in the developer portal. type: string required: true - name: Authorization in: header description: The Authorization Token type: string required: true - name: uuid in: header description: 128 bit UUID that you generate for every request type: string required: true - name: Accept in: header description: Content-Types that are acceptable for the response. Currently we support application/json. type: string required: true - name: Accept-Language in: header description: List of acceptable human languages for response type: string required: false - name: Content-Type in: header description: The media type of the body of the request (used with POST and PUT requests). Currently we support application/json type: string required: true - name: clientDetails in: header description: Device and browser information. Refer the developer portal for more information. Please ensure the header is base64 encoded type: string required: false - name: searchName in: query description: 'search name for the kladr address , support below search name: "City","Street","Doma"' type: string required: true - name: searchValue in: query description: User input value kladr code address search , this can be full name or practical name of the city/street/doma, but atleast two characters are required. type: string required: false - name: kladrCode in: query description: High level kladr code. KLADR refers to Russian postal address database. type: string required: true responses: 200: description: Successful operation. schema: $ref: '#/definitions/KladrAddressSearchResponse' 400: description:
invalidinvalidRequestMissing or invalid Parameters
invalidinvalidControlFlowIdControl flow ID is invalid
schema: $ref: '#/definitions/ErrorList' 401: description:
TypeCodeDetails
errorunAuthorizedAuthorization credentials are missing or invalid
schema: $ref: '#/definitions/ErrorList' 404: description:
TypeCodeDetails
errorinvalidApplicationApplication not found or invalid
schema: $ref: '#/definitions/ErrorList' 500: description:
TypeCodeDetails
fatalserverUnavailableThe request failed due to an internal error
schema: $ref: '#/definitions/ErrorList' /v1/utilities/referenceData/{referenceCode}: get: summary: Retrieve valid values description: Returns an array of valid values and descriptions for the specified field responses: 200: schema: $ref: '#/definitions/ReferenceDataTypeResponse' description: Successful operation. 400: schema: $ref: '#/definitions/ErrorResponse' description:
TypeCodeDetails
invalidinvalidRequestMissing or invalid parameters
401: schema: $ref: '#/definitions/ErrorResponse' description:
errorunAuthorizedAuthorization credentials are missing or invalid
403: schema: $ref: '#/definitions/ErrorResponse' description:
erroraccessNotConfiguredThe requested operation is not configured to access this resource.
404: schema: $ref: '#/definitions/ErrorResponse' description:
errorresourceNotFoundEmpty resource/resource not found
500: schema: $ref: '#/definitions/ErrorResponse' description:
fatalserverUnavailableThe request failed due to an internal error
parameters: - in: path name: referenceCode description: Reference Code type: string required: true - in: header name: Authorization description: 'The most recent Authorization token. This will have the format Bearer + {space} + {accessToken}. Example: Bearer KGNsaWVudF9pZDpjbGllbnRfc2VjcmV0KQ==.' type: string required: true - in: header name: uuid description: 128 bit random UUID generated uniquely for every request. type: string required: true - in: header name: Accept description: Content-Type that are acceptable for the response. type: string required: true - in: header name: client_id description: Client ID generated during application registration. type: string required: true tags: [] /v1/apac/utilities/referenceData/{referenceCode}: get: summary: Retrieve Reference Data Values description: This API is used to retrieve an array of valid values and descriptions for the specified field. responses: 200: schema: $ref: '#/definitions/ReferenceDataTypeResponse' description: Successful operation. 400: schema: $ref: '#/definitions/ErrorResponse' description:
TypeCodeDetails
invalidinvalidRequestMissing or invalid parameters
401: schema: $ref: '#/definitions/ErrorResponse' description:
errorunAuthorizedAuthorization credentials are missing or invalid
403: schema: $ref: '#/definitions/ErrorResponse' description:
erroraccessNotConfiguredThe requested operation is not configured to access this resource.Channel/Country/Business provided in the request is not supported currently
404: schema: $ref: '#/definitions/ErrorResponse' description:
errorresourceNotFoundEmpty resource/resource not found
500: schema: $ref: '#/definitions/ErrorResponse' description:
fatalserverUnavailableThe request failed due to an internal error
parameters: - in: path name: referenceCode description: Reference Code type: string required: true - in: header name: Authorization description: 'The most recent Authorization token. This will have the format Bearer + {space} + {accessToken}. Example: Bearer KGNsaWVudF9pZDpjbGllbnRfc2VjcmV0KQ==.' type: string required: true - in: header name: uuid description: 128 bit random UUID generated uniquely for every request. type: string required: true - in: header name: Accept description: Content-Type that are acceptable for the response. type: string required: true - in: header name: client_id description: Client ID generated during application registration. type: string required: true tags: [] security: - Client_id: [] consumes: - application/json produces: - application/json x-ibm-endpoints: - endpointUrl: https://sandbox.apihub.citi.com/gcb description: Custom Gateway API Endpoint type: - production - development ...