openapi: 3.2.0
info:
  title: Monite Entity onboarding data API
  contact:
    name: Monite team
    url: https://monite.com/about/
    email: developers@monite.com
  termsOfService: https://monite.com/terms
  version: '1.0'
  description: 'Operations tagged Entity onboarding data across 3 of this provider''s published API definitions: monite-openapi-2023-09-01.json, monite-openapi-2024-05-25.json, monite-openapi.yml. Each path carries the servers of the definition it was published in.'
servers:
- url: https://api.dev.monite.com/v1
  description: Development environment
- url: https://api.sandbox.monite.com/v1
  description: Sandbox environment
- url: https://api.monite.com/v1
  description: Production environment (Europe)
- url: https://us.api.monite.com/v1
  description: Production environment (North America)
- url: https://api.monite.oaknorth.co.uk/v1
  description: Oak POC environment
tags:
- name: Entity onboarding data
paths:
  /entities/{entity_id}/onboarding_data:
    get:
      tags:
      - Entity onboarding data
      summary: Get entity onboarding data
      operationId: get_entities_id_onboarding_data
      parameters:
      - required: true
        schema:
          type: string
          format: date
        example: '2023-09-01'
        name: x-monite-version
        in: header
      - name: entity_id
        in: path
        required: true
        schema:
          type: string
          format: uuid
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EntityOnboardingDataResponse'
        '405':
          description: Method Not Allowed
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorSchemaResponse'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorSchemaResponse'
        '404':
          description: Not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorSchemaResponse'
        '409':
          description: Business logic error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorSchemaResponse'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      security:
      - HTTPBearer: []
    put:
      tags:
      - Entity onboarding data
      summary: Update entity onboarding data
      description: Deprecated. Use `PATCH /entities/{entity_id}/onboarding_data` instead. Update entity onboarding data.
      operationId: put_entities_id_onboarding_data
      deprecated: true
      parameters:
      - required: true
        schema:
          type: string
          format: date
        example: '2023-09-01'
        name: x-monite-version
        in: header
      - name: entity_id
        in: path
        required: true
        schema:
          type: string
          format: uuid
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/EntityOnboardingDataRequest'
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EntityOnboardingDataResponse'
        '405':
          description: Method Not Allowed
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorSchemaResponse'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorSchemaResponse'
        '404':
          description: Not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorSchemaResponse'
        '409':
          description: Business logic error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorSchemaResponse'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      security:
      - HTTPBearer: []
    patch:
      tags:
      - Entity onboarding data
      summary: Patch entity onboarding data
      operationId: patch_entities_id_onboarding_data
      parameters:
      - required: true
        schema:
          type: string
          format: date
        example: '2023-09-01'
        name: x-monite-version
        in: header
      - name: entity_id
        in: path
        required: true
        schema:
          type: string
          format: uuid
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/EntityOnboardingDataRequest'
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EntityOnboardingDataResponse'
        '405':
          description: Method Not Allowed
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorSchemaResponse'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorSchemaResponse'
        '404':
          description: Not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorSchemaResponse'
        '409':
          description: Business logic error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorSchemaResponse'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      security:
      - HTTPBearer: []
    servers:
    - url: https://api.dev.monite.com/v1
      description: Development environment
    - url: https://api.sandbox.monite.com/v1
      description: Sandbox environment
    - url: https://api.monite.com/v1
      description: Production environment (Europe)
    - url: https://us.api.monite.com/v1
      description: Production environment (North America)
    - url: https://api.monite.oaknorth.co.uk/v1
      description: Oak POC environment
components:
  schemas:
    BusinessProfile-Input:
      properties:
        description_of_goods_or_services:
          anyOf:
          - type: string
            maxLength: 500
            minLength: 1
          - type: 'null'
          description: Required for US entities. A free-form description of the products the entity sells (whether online or at offline retail stores) or the services it provides to its customers.
          examples:
          - Acme Inc. is an online computer store that offers a wide range of computer products, laptops, smartphones, tablets, accessories, and more.
        estimated_monthly_revenue:
          anyOf:
          - $ref: '#/components/schemas/EstimatedMonthlyRevenue'
          - type: 'null'
          description: Required for US entities. The approximate revenue that the business generates per month.
        mcc:
          anyOf:
          - type: string
            maxLength: 4
            minLength: 4
          - type: 'null'
          description: The merchant category code of the entity. MCCs are used to classify businesses based on the goods or services they provide.
          examples:
          - '5734'
        operating_countries:
          anyOf:
          - items:
              $ref: '#/components/schemas/AllowedCountries'
            type: array
          - type: 'null'
          description: Required for US entities. A list of primary countries where the business conducts its operations, such as selling products or providing services. Use two-letter country codes (ISO 3166-2 alpha-2).
        url:
          anyOf:
          - type: string
            minLength: 1
            format: uri
          - type: 'null'
          description: The business's publicly available website.
      additionalProperties: false
      type: object
    EntityOnboardingDataResponse:
      properties:
        business_profile:
          anyOf:
          - $ref: '#/components/schemas/BusinessProfile-Output'
          - type: 'null'
          description: Business information about the entity.
        ownership_declaration:
          anyOf:
          - $ref: '#/components/schemas/OwnershipDeclaration-Output'
          - type: 'null'
          description: Used to attest that the beneficial owner information provided is both current and correct.
        tos_acceptance:
          anyOf:
          - $ref: '#/components/schemas/TermsOfServiceAcceptance-Output'
          - type: 'null'
          description: Details on the entity's acceptance of the service agreement.
        treasury_tos_acceptance:
          anyOf:
          - $ref: '#/components/schemas/TermsOfServiceAcceptance-Output'
          - type: 'null'
          description: Details on the entity's acceptance of the Stripe Treasury service agreement.
      type: object
    EstimatedMonthlyRevenue:
      properties:
        amount:
          anyOf:
          - type: integer
            maximum: 9.223372036854776e+18
            minimum: 1.0
          - type: 'null'
          description: The amount of the monthly revenue, in [minor units](https://docs.monite.com/references/currencies#minor-units). For example, $12.50 is represented as 1250.
          examples:
          - 250
        currency:
          anyOf:
          - $ref: '#/components/schemas/CurrencyEnum'
          - type: 'null'
          description: '[Currency code](https://docs.monite.com/references/currencies) of the revenue.'
          examples:
          - USD
      type: object
    TermsOfServiceAcceptance-Output:
      properties:
        date:
          anyOf:
          - type: string
            format: date-time
          - type: 'null'
          description: The date and time (in the ISO 8601 format) when the entity representative accepted the service agreement.
        ip:
          anyOf:
          - type: string
          - type: 'null'
          description: The IP address from which the entity representative accepted the service agreement. If omitted or set to `null` in the request, the IP address is inferred from the request origin or the `X-Forwarded-For` request header.
          examples:
          - 203.0.113.24
      additionalProperties: false
      type: object
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
      type: object
    ValidationError:
      properties:
        loc:
          items:
            anyOf:
            - type: string
            - type: integer
          type: array
        msg:
          type: string
        type:
          type: string
      type: object
      required:
      - loc
      - msg
      - type
    AllowedCountries:
      type: string
      enum:
      - AF
      - AX
      - AL
      - DZ
      - AS
      - AD
      - AO
      - AI
      - AQ
      - AG
      - AR
      - AM
      - AW
      - AU
      - AT
      - AZ
      - BS
      - BH
      - BD
      - BB
      - BY
      - BE
      - BZ
      - BJ
      - BM
      - BT
      - BO
      - BA
      - BW
      - BV
      - BR
      - IO
      - BN
      - BG
      - BF
      - BI
      - KH
      - CM
      - CA
      - IC
      - CV
      - KY
      - CF
      - EA
      - TD
      - CL
      - CN
      - CX
      - CC
      - CO
      - KM
      - CG
      - CD
      - CK
      - CR
      - CI
      - HR
      - CU
      - CY
      - CZ
      - DK
      - DJ
      - DM
      - DO
      - EC
      - EG
      - SV
      - GQ
      - ER
      - EE
      - SZ
      - ET
      - FK
      - FO
      - FJ
      - FI
      - FR
      - GF
      - PF
      - TF
      - GA
      - GM
      - GE
      - DE
      - GH
      - GI
      - GR
      - GL
      - GD
      - GP
      - GU
      - GT
      - GG
      - GN
      - GW
      - GY
      - HT
      - HM
      - VA
      - HN
      - HK
      - HU
      - IS
      - IN
      - ID
      - IR
      - IQ
      - IE
      - IM
      - IL
      - IT
      - JM
      - JP
      - JE
      - JO
      - KZ
      - KE
      - KI
      - KP
      - KR
      - KW
      - KG
      - LA
      - LV
      - LB
      - LS
      - LR
      - LY
      - LI
      - LT
      - LU
      - MO
      - MG
      - MW
      - MY
      - MV
      - ML
      - MT
      - MH
      - MQ
      - MR
      - MU
      - YT
      - MX
      - FM
      - MD
      - MC
      - MN
      - ME
      - MS
      - MA
      - MZ
      - MM
      - NA
      - NR
      - NP
      - NL
      - AN
      - NC
      - NZ
      - NI
      - NE
      - NG
      - NU
      - NF
      - MP
      - MK
      - 'NO'
      - OM
      - PK
      - PW
      - PS
      - PA
      - PG
      - PY
      - PE
      - PH
      - PN
      - PL
      - PT
      - PR
      - QA
      - RE
      - RO
      - RU
      - RW
      - SH
      - KN
      - LC
      - PM
      - VC
      - WS
      - SM
      - ST
      - SA
      - SN
      - RS
      - SC
      - SL
      - SG
      - SK
      - SI
      - SB
      - SO
      - ZA
      - SS
      - GS
      - ES
      - LK
      - SD
      - SR
      - SJ
      - SE
      - CH
      - SY
      - TW
      - TJ
      - TZ
      - TH
      - TL
      - TG
      - TK
      - TO
      - TT
      - TN
      - TR
      - TM
      - TC
      - TV
      - UG
      - UA
      - AE
      - GB
      - US
      - UM
      - UY
      - UZ
      - VU
      - VE
      - VN
      - VG
      - VI
      - WF
      - EH
      - YE
      - ZM
      - ZW
      - BL
      - BQ
      - CW
      - MF
      - SX
    ErrorSchema:
      properties:
        message:
          type: string
      type: object
      required:
      - message
    ErrorSchemaResponse:
      properties:
        error:
          $ref: '#/components/schemas/ErrorSchema'
      type: object
      required:
      - error
    TermsOfServiceAcceptance-Input:
      properties:
        date:
          anyOf:
          - type: string
            format: date-time
          - type: 'null'
          description: The date and time (in the ISO 8601 format) when the entity representative accepted the service agreement.
        ip:
          anyOf:
          - type: string
            format: ipvanyaddress
          - type: 'null'
          description: The IP address from which the entity representative accepted the service agreement. If omitted or set to `null` in the request, the IP address is inferred from the request origin or the `X-Forwarded-For` request header.
          examples:
          - 203.0.113.24
      additionalProperties: false
      type: object
    EntityOnboardingDataRequest:
      properties:
        business_profile:
          anyOf:
          - $ref: '#/components/schemas/BusinessProfile-Input'
          - type: 'null'
          description: Business information about the entity.
        ownership_declaration:
          anyOf:
          - $ref: '#/components/schemas/OwnershipDeclaration-Input'
          - type: 'null'
          description: Used to attest that the beneficial owner information provided is both current and correct.
        tos_acceptance:
          anyOf:
          - $ref: '#/components/schemas/TermsOfServiceAcceptance-Input'
          - type: 'null'
          description: Details on the entity's acceptance of the service agreement.
        treasury_tos_acceptance:
          anyOf:
          - $ref: '#/components/schemas/TermsOfServiceAcceptance-Input'
          - type: 'null'
          description: Details on the entity's acceptance of the Stripe Treasury service agreement.
      additionalProperties: false
      type: object
    BusinessProfile-Output:
      properties:
        description_of_goods_or_services:
          anyOf:
          - type: string
            maxLength: 500
            minLength: 1
          - type: 'null'
          description: Required for US entities. A free-form description of the products the entity sells (whether online or at offline retail stores) or the services it provides to its customers.
          examples:
          - Acme Inc. is an online computer store that offers a wide range of computer products, laptops, smartphones, tablets, accessories, and more.
        estimated_monthly_revenue:
          anyOf:
          - $ref: '#/components/schemas/EstimatedMonthlyRevenue'
          - type: 'null'
          description: Required for US entities. The approximate revenue that the business generates per month.
        mcc:
          anyOf:
          - type: string
            maxLength: 4
            minLength: 4
          - type: 'null'
          description: The merchant category code of the entity. MCCs are used to classify businesses based on the goods or services they provide.
          examples:
          - '5734'
        operating_countries:
          anyOf:
          - items:
              $ref: '#/components/schemas/AllowedCountries'
            type: array
          - type: 'null'
          description: Required for US entities. A list of primary countries where the business conducts its operations, such as selling products or providing services. Use two-letter country codes (ISO 3166-2 alpha-2).
        url:
          anyOf:
          - type: string
            minLength: 1
            format: uri
          - type: 'null'
          description: The business's publicly available website.
      additionalProperties: false
      type: object
    OwnershipDeclaration-Input:
      properties:
        date:
          anyOf:
          - type: string
            format: date-time
          - type: 'null'
          description: The date and time (in the ISO 8601 format) when the beneficial owner attestation was made.
        ip:
          anyOf:
          - type: string
            format: ipvanyaddress
          - type: 'null'
          description: The IP address from which the beneficial owner attestation was made. If omitted or set to `null` in the request, the IP address is inferred from the request origin or the `X-Forwarded-For` request header.
          examples:
          - 203.0.113.24
      additionalProperties: false
      type: object
    OwnershipDeclaration-Output:
      properties:
        date:
          anyOf:
          - type: string
            format: date-time
          - type: 'null'
          description: The date and time (in the ISO 8601 format) when the beneficial owner attestation was made.
        ip:
          anyOf:
          - type: string
          - type: 'null'
          description: The IP address from which the beneficial owner attestation was made. If omitted or set to `null` in the request, the IP address is inferred from the request origin or the `X-Forwarded-For` request header.
          examples:
          - 203.0.113.24
      additionalProperties: false
      type: object
    CurrencyEnum:
      type: string
      enum:
      - AED
      - AFN
      - ALL
      - AMD
      - ANG
      - AOA
      - ARS
      - AUD
      - AWG
      - AZN
      - BAM
      - BBD
      - BDT
      - BGN
      - BHD
      - BIF
      - BMD
      - BND
      - BOB
      - BRL
      - BSD
      - BTN
      - BWP
      - BYN
      - BZD
      - CAD
      - CDF
      - CHF
      - CLP
      - CNY
      - COP
      - CRC
      - CVE
      - CZK
      - DJF
      - DKK
      - DOP
      - DZD
      - EGP
      - ETB
      - EUR
      - FJD
      - FKP
      - GBP
      - GEL
      - GHS
      - GIP
      - GMD
      - GNF
      - GTQ
      - GYD
      - HKD
      - HNL
      - HTG
      - HUF
      - IDR
      - ILS
      - INR
      - IQD
      - ISK
      - JMD
      - JOD
      - JPY
      - KES
      - KGS
      - KHR
      - KMF
      - KRW
      - KWD
      - KYD
      - KZT
      - LAK
      - LBP
      - LKR
      - LRD
      - LSL
      - LYD
      - MAD
      - MDL
      - MGA
      - MKD
      - MMK
      - MNT
      - MOP
      - MUR
      - MVR
      - MWK
      - MXN
      - MYR
      - MZN
      - NAD
      - NGN
      - NIO
      - NOK
      - NPR
      - NZD
      - OMR
      - PAB
      - PEN
      - PGK
      - PHP
      - PKR
      - PLN
      - PYG
      - QAR
      - RON
      - RSD
      - RUB
      - RWF
      - SAR
      - SBD
      - SCR
      - SEK
      - SGD
      - SHP
      - SLE
      - SOS
      - SRD
      - SSP
      - SVC
      - SZL
      - THB
      - TJS
      - TMT
      - TND
      - TOP
      - TRY
      - TTD
      - TWD
      - TZS
      - UAH
      - UGX
      - USD
      - UYU
      - UZS
      - VND
      - VUV
      - WST
      - XAF
      - XCD
      - XOF
      - XPF
      - YER
      - ZAR
      - ZMW
  securitySchemes:
    HTTPBearer:
      type: http
      scheme: bearer
x-refined-from:
- monite-openapi-2023-09-01.json
- monite-openapi-2024-05-25.json
- monite-openapi.yml