--- swagger: "2.0" info: title: XLG-SEC-P-TransmitAccessRecovery description: This purpose of this Microservice is to perform the operations with transmit soft token in SSS to recover customer's access. This is an Orchestrator service. version: 1.0.0 x-ibm-name: xlg-sec-p-transmitaccessrecovery host: 127.0.0.1 schemes: - https basePath: /api produces: - application/json paths: /v1/x-global/security/customers/electronic-banking/access/unlock: post: tags: - transmit-unlock-customer-access operationId: transmit-unlock-customer-access summary: To unlock a customer access to electronic banking using the transmit soft token through SSS description: This API is used to unlock a customer access to electronic banking using the transmit soft token through SSS consumes: - application/json produces: - application/json parameters: - name: client_id in: header required: false type: string description: Client ID generated during application registration - name: Authorization in: header required: false type: string description: The Authorization Token received during login - name: Accept in: header required: true type: string description: Content-Types that are acceptable for the response - name: uuid in: header required: true type: string description: 128 bit UUID that you generate for every request - name: Accept-Language in: header required: false type: string description: List of acceptable human languages for response - name: Content-Type in: header required: true type: string description: Content-Types that are sent in the request - name: countryCode in: header required: true type: string description: Country code in 2 character ISO 3166 format - name: businessCode in: header required: true type: string description: Business code identified during application registration - name: ChannelId in: header required: true type: string description: Channel where request originated - name: sid in: header required: false type: string description: SessionId sent by Consumer - name: unlockCustomerRequest in: body required: true schema: $ref: '#/definitions/UnlockCustomerRequest' responses: 200: description: Successful operation. 400: description:
TypeCodeDetails
errorinvalidRequestMissing or invalid Parameters
schema: $ref: '#/definitions/ErrorResponse' 401: description:
TypeCodeDetails
errorunAuthorizedAuthorization credentials are missing or invalid
schema: $ref: '#/definitions/ErrorResponse' 403: description:
TypeCodeDetailsMore Info
erroraccessNotConfiguredThe request operation is not configured to access this resourceChannel/Country/Business provided in the request is not supported currently
schema: $ref: '#/definitions/ErrorResponse' 404: description:
TypeCodeDetailsMore Info
errorresourceNotFoundThe requested resource was not foundEmpty resource/resource not found
schema: $ref: '#/definitions/ErrorResponse' 422: description:
TypeCodeDetails
errorbusinessValidationFailedBusiness validation error occured on one or more parameters
schema: $ref: '#/definitions/ErrorResponse' 500: description:
TypeCodeDetails
fatalserverUnavailableThe request failed due to an internal error/server unavailability
schema: $ref: '#/definitions/ErrorResponse' definitions: UnlockCustomerRequest: type: object properties: jwtToken: type: string example: kkhljsdf87sdifskjfsdhkf8fsdf description: JWT to validate customer email. grantType: type: string example: "2" maxLength: 2 pattern: ^[0-9]{1,2}$ description: Id of the token, used for identifying the kind of functional Id also known as applicationId for calling the transmit JWT validator service
tokenIdDetails
1SMS-OTP functional Id
2binding functional Id
3New Online Transaction functional Id
4Avatar Transaction functional Id
5IVR Transaction functional ID
6AcciTrade Transaction functional ID
7Directo Transaction functional ID
customer: $ref: '#/definitions/Customer' required: - jwtToken - customer Customer: type: object properties: customerId: description: Unique identifier of the customer type: string example: "123456789012" maxLength: 12 legalRepresentativeId: description: Unique identifier for corporate legal Representative. Only for Corporate customers type: string pattern: ^[0-9]{1,2}$ example: "1" maxLength: 2 required: - customerId ErrorResponse: properties: type: type: string 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 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: More Info can be used to pass any additional details type: string uuid: description: 128 bit UUID that you generate for every request type: string timestamp: description: Timestamp of the error type: string required: - type - code x-ibm-configuration: enforced: true testable: true phase: realized securityDefinitions: OAuth2 Application Flow: type: oauth2 description: "" flow: application scopes: /api/v1: "" tokenUrl: https://api.banamex.com/mx-gcgapi/api/v1/oauth/token Client ID: type: apiKey description: "" in: header name: X-IBM-Client-Id security: - OAuth2 Application Flow: - /api/v1 Client ID: [] x-ibm-endpoints: - endpointUrl: https://api.banamex.com/mx-gcgapi type: - production - development ...