Bit2Me Misc API

openapi: 3.2.0
info:
  title: Bit2Me API Gateway Misc API
  version: 2.0.0
tags:
- name: Misc
paths:
  /v1/misc/country/{countryISOCode}/region:
    get:
      description: 'Returns the first-level subdivisions of a country, such as states or autonomous

        communities, sorted by `name`. Codes follow ISO 3166-2

        without the country prefix: Andalusia is `AN`, not `ES-AN`.


        Region entries carry `iso`, `name` and `fips`. They do **not** include `iso3`, which

        appears only on the country list returned by `GET /v1/misc/country`.


        A well-formed code with no data returns `200` with an empty array, not `404`. Curaçao

        (`CW`), Kosovo (`XK`) and Gibraltar (`GI`) return a single entry for the territory itself,

        with the country code as `iso` and `fips` `00`.


        No authentication is required.'
      parameters:
      - description: ISO 3166-1 alpha-2 country code, in uppercase.
        example: ES
        in: path
        name: countryISOCode
        required: true
        schema:
          pattern: ^[A-Z]{2}$
          type: string
      - description: 'Language of `name`. `EN` and `ES` are accepted in any case; `en-US` and `en-GB` map to

          English, `es-ES` and `es-AR` to Spanish, and `pt`, `pt-PT` and `pt-BR` to Portuguese.

          `it` and `fr` are also accepted. Any other value falls back to English.

          '
        example: ES
        in: query
        name: langCode
        schema:
          default: EN
          type: string
      responses:
        '200':
          content:
            application/json:
              examples:
                spain:
                  summary: Spanish autonomous communities
                  value:
                  - fips: '51'
                    iso: AN
                    name: Andalusia
                  - fips: '52'
                    iso: AR
                    name: Aragon
                unknownCountry:
                  summary: Well-formed code with no data
                  value: []
              schema:
                description: First-level subdivisions of a country, sorted by `name`.
                items:
                  properties:
                    fips:
                      description: FIPS 10-4 code of the subdivision; `00` for territories without subdivisions.
                      example: '51'
                      pattern: ^[A-Z0-9]{2}$
                      type: string
                    iso:
                      description: 'ISO 3166-2 subdivision code without the country prefix. For territories without

                        subdivisions it is the country code itself.

                        '
                      example: AN
                      pattern: ^[A-Z0-9]{1,3}$
                      type: string
                    name:
                      description: Name of the subdivision in the language selected by `langCode`.
                      example: Andalusia
                      type: string
                  required:
                  - iso
                  - name
                  - fips
                  type: object
                type: array
          description: Regions of the requested country. Empty when there are none.
        '400':
          content:
            application/json:
              examples:
                invalidCountryCode:
                  value:
                    error: Bad Request
                    message:
                    - 'invalid countryISOCode. It should be a ISO 3166 Alpha-2 (ex: ES, AD)'
                    statusCode: 400
              schema:
                description: 'Returned with `400` when the request is rejected field by field rather than against the

                  published contract. It is not the same shape as the contract validation error, and the

                  difference that catches integrators out is that **`message` is an array of strings here**,

                  while everywhere else it is a single string.

                  '
                properties:
                  error:
                    description: Reason phrase of the HTTP status.
                    example: Bad Request
                    type: string
                  message:
                    description: One human-readable sentence per failed constraint.
                    example:
                    - iban should not be empty
                    - iban must be a string
                    items:
                      type: string
                    type: array
                  statusCode:
                    description: Repeats the HTTP status code.
                    example: 400
                    type: integer
                required:
                - message
                - error
                - statusCode
                type: object
          description: '`countryISOCode` is not two uppercase letters.'
      security:
      - NoAuth: []
      summary: List regions for a country
      tags:
      - Misc
      x-product:
        wallet: Misc
      operationId: getV1MiscCountryByCountryISOCodeRegion
      x-operation-id-source: derived
components:
  securitySchemes:
    ApiKeyAuth:
      description: 'For accessing these endpoints a valid API key must be sent in the *X-Api-Key* header.

        '
      in: header
      name: X-Api-Key
      type: apiKey
    BasicAuth:
      description: "Access control to the API is always controlled by a JWT token. To get this token you must log in through */v3/signin* (email and password).\n\nThe client sends requests with the Authorization header that contains the Basic word followed by a space and a base64-encoded username:password string.\nExample:\n    Authorization: Basic ZGVtbzpwQDU1dzByZA==\n"
      in: header
      name: Authorization
      type: apiKey
    CustomApiKey:
      description: 'For accessing a specific API endpoint of this type, a valid API key must be passed in the *Authorization* header.

        '
      in: header
      name: Authorization
      type: apiKey
    JwtAuth:
      description: "For accessing the API a valid JWT token must be passed in the *Authorization* header.\n\nA valid JWT token is generated by the API and returned after calling */v1/signin* with valid credentials.\n\nExample:\n    Authorization: Bearer xxxxxx.yyyyyyy.zzzzzz\n"
      in: header
      name: Authorization
      type: apiKey
    JwtPreAuth:
      description: "The pre-auth token proves the password only, while a sign-in waits for its second step. It is the\n*accessToken* returned with *sfa: true* by *POST /v4/signin* or *POST /v2/signin/oauth/{provider}*.\nSend it in the *Authorization* header as a Bearer token.\n\nIt is accepted only by these routes:\n  - *POST /v1/auth/two-step-verification/initiate*\n  - *POST /v1/auth/two-step-verification/reissue*\n  - *POST /v1/auth/two-step-verification/verify*\n  - *POST /v4/signin/sfa*\n\nsuite-auth verifies the token on every call (it is never cached). A refused token is answered with 403.\n\nExample:\n    Authorization: Bearer xxxxxx.yyyyyyy.zzzzzz\n"
      in: header
      name: Authorization
      type: apiKey
x-tagGroups:
- name: Basic Info
  tags:
  - Crypto Suite
- name: Crypto Suite Endpoints
  tags:
  - Account
  - Accounting
  - Affiliates
  - Auth
  - Blockchain Manager
  - Brokerage
  - Captcha
  - Card
  - Card Authorizator
  - Card Loyalty
  - Collection Orders
  - Commerce
  - Compliance
  - Configuration
  - Crypto Credentials
  - Currency
  - Currency Analytics
  - Currency Collections
  - Currency Favorites
  - Earn
  - External Onboarding
  - Instant
  - Junior
  - Launchpad
  - Loan
  - Misc
  - Notification
  - Portfolio
  - Portfolio Analytics
  - Price Alert Scheduler
  - Price Orders
  - Price Watchdog
  - Promotion
  - Recurring Orders
  - Pay
  - Redeem Token
  - Space Center
  - Stocks
  - Support
  - Taxes
  - Teller
  - Terms and Conditions
  - Travel Rule
  - Trading
  - Translations
  - UX
  - Verifier
  - Wallet
- name: Deprecated
  tags:
  - Account Deprecated Methods
  - Auth Deprecated Methods
  - Currency Deprecated Methods
  - Earn Deprecated Methods
  - Verifier Deprecated Methods