Bridge Lists API

openapi: 3.0.2
info:
  title: Bridge API Keys Lists API
  description: APIs to move into, out of, and between any form of a dollar
  version: '1'
servers:
- url: https://api.bridge.xyz/v0
  description: The base path for all resources
security:
- ApiKey: []
tags:
- name: Lists
paths:
  /lists/occupation_codes:
    get:
      summary: Get occupation codes
      description: 'Provide this list of occupation codes to your users as possible answers to the Source of Funds section in the KYC flow. The returned list will resemble the list of occupation codes found [here](https://apidocs.bridge.xyz/page/sof-eu-most-recent-occupation-list).

        '
      tags:
      - Lists
      responses:
        '200':
          description: The list of occupations that can be used during the KYC flow.
          content:
            application/json:
              schema:
                type: array
                items:
                  type: object
                  properties:
                    display_name:
                      type: string
                      example: Accountant and auditor
                      description: Human readable name that customers can select.
                    code:
                      type: string
                      example: '132011'
                      description: The corresponding code that should be sent to the Bridge API representing the customers selection.
              examples:
                OccupationCodesSuccessResponse:
                  $ref: '#/components/examples/OccupationCodesSuccessResponse'
  /lists/countries:
    get:
      summary: Get countries
      description: Returns a list of countries and subdivisions recognized by Bridge. Inclusion in this list does not guarantee Bridge product support for any country or subdivision.
      tags:
      - Lists
      responses:
        '200':
          description: List of supported countries
          content:
            application/json:
              schema:
                title: Countries
                type: object
                required:
                - count
                - data
                properties:
                  count:
                    description: The total number of countries recognized by Bridge
                    type: integer
                  data:
                    type: array
                    description: The list of countries recognized by Bridge
                    minItems: 0
                    items:
                      $ref: '#/components/schemas/Country'
components:
  examples:
    OccupationCodesSuccessResponse:
      summary: The list of occupations that can be used during the KYC flow.
      value:
      - display_name: Accountant and auditor
        code: '132011'
      - display_name: Actor
        code: '272011'
      - display_name: Acupuncturist
        code: '291291'
      - display_name: Administrative services manager
        code: '113012'
      - display_name: Other
        code: other
  schemas:
    Subdivision:
      required:
      - name
      - code
      properties:
        name:
          description: The name of the subdivision
          type: string
          minLength: 1
        code:
          description: The subdivision code, which can be used in place of the name when interacting with Bridge via API
          type: string
          minLength: 2
    Country:
      required:
      - name
      - alpha3
      - subdivisions
      properties:
        name:
          description: The name of the country
          type: string
          minLength: 1
        alpha3:
          description: The three-letter alpha-3 country code as defined in the ISO 3166-1 spec, used in Bridge APIs
          type: string
          minLength: 3
          maxLength: 3
        postal_code_format:
          description: A [Ruby-formatted regular expression](https://ruby-doc.org/3.4.2/Regexp.html) that matches valid postal codes for the country, or null if the country does not use postal codes.
          type: string
          minLength: 1
        subdivisions:
          description: A list of subdivisions for the country
          type: array
          minItems: 0
          items:
            $ref: '#/components/schemas/Subdivision'
  securitySchemes:
    ApiKey:
      type: apiKey
      name: Api-Key
      in: header