--- 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. version: 1.0.0m title: Utilities x-ibm-name: utilities_100m basePath: /api schemes: - https x-ibm-configuration: enforced: true phase: realized testable: true tags: [] definitions: 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 ApiMetadataInquiryResponse: properties: requestElementDetails: type: array items: $ref: '#/definitions/RequestElementDetails' responseElementDetails: type: array items: $ref: '#/definitions/ResponseElementDetails' ErrorResponse: 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

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: 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 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 ReferenceDataTypeResponse: properties: referenceDataDetails: type: array items: $ref: '#/definitions/ReferenceData' securityDefinitions: API Key: type: apiKey name: X-IBM-Client-Id in: header description: "" paths: /v1/utilities/metaData: get: summary: Metadata Inquiry description: Returns field properties and validations applied for a specific market tags: [] parameters: - name: Authorization in: header description: 'The most recent Authorization token. This will have the format Bearer + {space} + {accessToken}. Example: Bearer KGNsaWVudF9pZDpjbGllbnRfc2VjcmV0KQ==.' type: string required: true - name: uuid in: header description: 128 bit random UUID generated uniquely for every request. type: string required: true - name: Accept in: header description: Content-Type that are acceptable for the response. type: string required: true - name: client_id in: header description: Client ID generated during application registration. required: true type: string - name: apiUri in: query description: 'The URI for the target documentation. Example: /v1/apac/onboarding/products/unsecured/applications' type: string required: true - name: apiMethod in: query description: The HTTP method required to invoke this operation. enum: - GET - POST - PUT - DELETE type: string required: true responses: 200: description: Successful operation. schema: $ref: '#/definitions/ApiMetadataInquiryResponse' 400: description:
TypeCodeDetails
invalidinvalidRequestMissing or invalid Parameters
schema: $ref: '#/definitions/ErrorResponse' 401: description:
errorunAuthorizedAuthorization credentials are missing or invalid
schema: $ref: '#/definitions/ErrorResponse' 403: description:
erroraccessNotConfiguredThe request operation is not configured to access this resource
schema: $ref: '#/definitions/ErrorResponse' 404: description:
errorresourceNotFoundEmpty resource/resource not found
schema: $ref: '#/definitions/ErrorResponse' 500: description:
fatalserverUnavailableThe request failed due to an internal error
schema: $ref: '#/definitions/ErrorResponse' /v1/apac/utilities/referenceData/{referenceCode}: get: summary: Retrieve valid values description: Returns an array of valid values and descriptions for the specified field tags: [] parameters: - name: referenceCode in: path description: Reference Code type: string required: true - name: Authorization in: header description: 'The most recent Authorization token. This will have the format Bearer + {space} + {accessToken}. Example: Bearer KGNsaWVudF9pZDpjbGllbnRfc2VjcmV0KQ==.' type: string required: true - name: uuid in: header description: 128 bit random UUID generated uniquely for every request. type: string required: true - name: Accept in: header description: Content-Type that are acceptable for the response. type: string required: true - name: client_id in: header description: Client ID generated during application registration. required: true type: string responses: 200: description: Successful operation. schema: $ref: '#/definitions/ReferenceDataTypeResponse' 400: description:
TypeCodeDetails
invalidinvalidRequestMissing or invalid parameters
schema: $ref: '#/definitions/ErrorResponse' 401: description:
errorunAuthorizedAuthorization credentials are missing or invalid
schema: $ref: '#/definitions/ErrorResponse' 403: description:
erroraccessNotConfiguredThe requested operation is not configured to access this resource.Channel/Country/Business provided in the request is not supported currently
schema: $ref: '#/definitions/ErrorResponse' 404: description:
errorresourceNotFoundEmpty resource/resource not found
schema: $ref: '#/definitions/ErrorResponse' 500: description:
fatalserverUnavailableThe request failed due to an internal error
schema: $ref: '#/definitions/ErrorResponse' security: - API Key: [] consumes: - application/json produces: - application/json x-ibm-endpoints: - endpointUrl: https://sandbox.apihub.citi.com/gcb description: Custom Gateway API Endpoint type: - production - development ...