> ## Documentation Index
> Fetch the complete documentation index at: https://docs.quidkey.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Create a bank account

> Adds an account the merchant owns, with the roles `payment` and `payout`. It's created `active`, and its `ownership_status` starts `pending`. Another `owned` account can't be added here while one is active, unless `is_multi_account_allowed`. A bank link isn't limited by this. `consent` records the person's authorisation of debits from the account with the create. Leave it out to record it later through `agreement_acceptance`, naming the account. The `CONSENT_AGREEMENT_*` codes name the agreement in `details`. A retry with the same key answers the account the first one created, and records no consent again.

Credentials: `partner`, `merchant`

Permission: `bank-accounts:create`



## OpenAPI

````yaml /api-reference/v1/openapi.json post /merchants/{id}/bank-accounts
openapi: 3.1.0
info:
  title: Quidkey API
  version: 1.0.0
  description: >-
    The Quidkey public API.


    Within a version, a response can carry what this document doesn't list yet:
    a new field, a new value of an enum, a new error code. Handle a value you
    don't recognise rather than refusing the response. A client generated from
    this document turns an `enum` into a closed type unless told otherwise, so
    turn on its option for unknown values, such as openapi-generator's
    `enumUnknownDefaultCase`. A request is held to what's listed: a value it
    doesn't list is refused.
  contact:
    name: Quidkey
    url: https://docs.quidkey.com
servers:
  - url: https://api.quidkey.com/v1
security:
  - bearer: []
tags:
  - name: account_owner
  - name: agreement
  - name: agreement_acceptance
  - name: api_key
  - name: bank
  - name: bank_account
  - name: capability
  - name: country
  - name: identity_verification
  - name: legal_entity
  - name: merchant
  - name: party
  - name: payment_link
  - name: payout
  - name: transaction
  - name: webhook_endpoint
paths:
  /merchants/{id}/bank-accounts:
    post:
      tags:
        - bank_account
      summary: Create a bank account
      description: >-
        Adds an account the merchant owns, with the roles `payment` and
        `payout`. It's created `active`, and its `ownership_status` starts
        `pending`. Another `owned` account can't be added here while one is
        active, unless `is_multi_account_allowed`. A bank link isn't limited by
        this. `consent` records the person's authorisation of debits from the
        account with the create. Leave it out to record it later through
        `agreement_acceptance`, naming the account. The `CONSENT_AGREEMENT_*`
        codes name the agreement in `details`. A retry with the same key answers
        the account the first one created, and records no consent again.


        Credentials: `partner`, `merchant`


        Permission: `bank-accounts:create`
      operationId: bank_account.create
      parameters:
        - name: id
          in: path
          required: true
          schema:
            minLength: 1
            type: string
        - name: Idempotency-Key
          in: header
          required: true
          description: >-
            1 to 255 printable ASCII characters with no spaces, quotes or
            backslashes, in double quotes as the IETF draft defines, or without
            them. We recommend a UUID. Make one for each thing you mean to
            happen once and store it before you send the request, so a retry
            after a crash sends the same key. Keys are scoped to your account
            and the endpoint, not to a token, so a new token or a rotated secret
            doesn't affect a retry. A partner and its merchant are separate
            accounts, so the same key sent with each credential starts two
            requests. Keys are kept for at least 7 days. After that, the same
            key starts a new request.
          schema:
            type: string
            minLength: 1
            maxLength: 257
            pattern: >-
              ^(?:([\x21\x23-\x5B\x5D-\x7E]{1,255})|"([\x21\x23-\x5B\x5D-\x7E]{1,255})")$
      requestBody:
        required: true
        content:
          application/json:
            schema:
              additionalProperties: false
              type: object
              required:
                - currency
                - country
                - account_holder_name
              properties:
                currency:
                  pattern: ^[A-Z]{3}$
                  type: string
                country:
                  pattern: ^[A-Z]{2}$
                  type: string
                  description: Must be a country Quidkey activates for domestic payments.
                account_holder_name:
                  minLength: 1
                  type: string
                iban:
                  minLength: 1
                  description: >-
                    Write-only. An IBAN that can't address the account's country
                    is refused. Which identifiers a country needs is listed in
                    the reference.
                  type: string
                account_number:
                  minLength: 1
                  description: Write-only.
                  type: string
                bban:
                  minLength: 1
                  description: Write-only.
                  type: string
                plusgiro_number:
                  minLength: 1
                  description: Write-only.
                  type: string
                bic:
                  minLength: 1
                  type: string
                sort_code:
                  minLength: 1
                  type: string
                routing_number:
                  minLength: 1
                  type: string
                bsb:
                  minLength: 1
                  type: string
                payment_schemes:
                  minItems: 1
                  maxItems: 10
                  description: >-
                    Read-only after create. Left out, the country's schemes are
                    attached and active, except an additional payment method
                    such as `multibanco`, which an account only has by naming
                    it. What a country offers is on the country's
                    `payment_schemes`.
                  type: array
                  items:
                    additionalProperties: false
                    type: object
                    required:
                      - id
                      - is_active
                    properties:
                      _type:
                        const: payment_scheme
                        type: string
                      id:
                        type: string
                        enum:
                          - sepa_credit_transfer
                          - sepa_instant_credit_transfer
                          - multibanco
                          - danish_domestic_credit_transfer
                          - faster_payments
                          - bacs
                          - ach
                          - becs
                        description: >-
                          The scheme's stable code. What a country offers is on
                          the country's `payment_schemes`.
                      is_active:
                        description: >-
                          Whether Quidkey offers this scheme for a payment
                          transaction routed to this account. A false doesn't by
                          itself refuse a payment transaction.
                        type: boolean
                consent:
                  $ref: '#/components/schemas/Consent'
                  description: >-
                    The person authorises Quidkey and its processors to debit
                    this account for amounts due to Quidkey. `agreements` must
                    hold the current `bank_debit_authorization` version and
                    nothing else. Optional. Send it to record the person's
                    acceptance with the create, or accept later through
                    `agreement_acceptance`.
      responses:
        '201':
          description: The bank_account, in the full view.
          headers:
            X-Request-Id:
              $ref: '#/components/headers/RequestId'
            Idempotent-Replayed:
              $ref: '#/components/headers/IdempotentReplayed'
            Location:
              description: The URL of the created resource.
              schema:
                type: string
          content:
            application/json:
              schema:
                additionalProperties: false
                type: object
                required:
                  - result
                  - entities
                  - not_included
                properties:
                  result:
                    $ref: '#/components/schemas/BankAccountFull'
                  entities:
                    additionalProperties: false
                    description: Nothing can be included here.
                    type: object
                    properties: {}
                  not_included:
                    type: array
                    items:
                      $ref: '#/components/schemas/NotIncludedEntry'
        '400':
          description: >-
            `BANK_ACCOUNT_CURRENCY_UNSUPPORTED`: The account's country, or the
            country its IBAN was issued in, can't be paid in this currency.


            `BANK_DETAILS_COUNTRY_MISMATCH`: This IBAN can't address an account
            in this country.


            `BANK_DETAILS_INCOMPLETE`: The bank details don't include what this
            country requires.


            `BANK_DETAILS_INVALID`: The bank details aren't valid, such as an
            IBAN that doesn't pass its checks.


            `CONSENT_ACCEPTED_AT_INVALID`: accepted_at is before the agreement
            took effect, too far in the future or too old.


            `CONSENT_AGREEMENT_DUPLICATE`: Consent names the same agreement more
            than once.


            `CONSENT_AGREEMENT_MISSING`: Consent is missing an agreement this
            operation requires.


            `CONSENT_AGREEMENT_NOT_REQUIRED`: Consent names an agreement this
            operation doesn't require.


            `CONSENT_AGREEMENT_STALE`: Consent names an agreement version that
            isn't current.


            `CONSENT_NOT_ACCEPTED`: `is_accepted` must be `true`, stating that
            the person accepted.


            `COUNTRY_NOT_SUPPORTED`: This country isn't supported.


            `CURRENCY_NOT_SUPPORTED`: This currency isn't supported.


            `DUPLICATE_PAYMENT_SCHEMES`: The same payment scheme is listed more
            than once.


            `IDEMPOTENCY_KEY_REQUIRED`: This endpoint requires an
            Idempotency-Key header.


            `SCHEME_NOT_AVAILABLE_IN_COUNTRY`: A payment scheme isn't available
            in this country.


            `UNKNOWN_AGREEMENT`: This names no agreement.


            `VALIDATION_FAILED`: The request is malformed or failed validation.
          headers:
            X-Request-Id:
              $ref: '#/components/headers/RequestId'
            Idempotent-Replayed:
              $ref: '#/components/headers/IdempotentReplayed'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
          x-error-codes:
            - BANK_ACCOUNT_CURRENCY_UNSUPPORTED
            - BANK_DETAILS_COUNTRY_MISMATCH
            - BANK_DETAILS_INCOMPLETE
            - BANK_DETAILS_INVALID
            - CONSENT_ACCEPTED_AT_INVALID
            - CONSENT_AGREEMENT_DUPLICATE
            - CONSENT_AGREEMENT_MISSING
            - CONSENT_AGREEMENT_NOT_REQUIRED
            - CONSENT_AGREEMENT_STALE
            - CONSENT_NOT_ACCEPTED
            - COUNTRY_NOT_SUPPORTED
            - CURRENCY_NOT_SUPPORTED
            - DUPLICATE_PAYMENT_SCHEMES
            - IDEMPOTENCY_KEY_REQUIRED
            - SCHEME_NOT_AVAILABLE_IN_COUNTRY
            - UNKNOWN_AGREEMENT
            - VALIDATION_FAILED
        '401':
          description: '`UNAUTHENTICATED`: A valid bearer token is required.'
          headers:
            X-Request-Id:
              $ref: '#/components/headers/RequestId'
            Idempotent-Replayed:
              $ref: '#/components/headers/IdempotentReplayed'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
          x-error-codes:
            - UNAUTHENTICATED
        '403':
          description: >-
            `FORBIDDEN`: This credential doesn't have permission for this
            endpoint.
          headers:
            X-Request-Id:
              $ref: '#/components/headers/RequestId'
            Idempotent-Replayed:
              $ref: '#/components/headers/IdempotentReplayed'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
          x-error-codes:
            - FORBIDDEN
        '404':
          description: '`NOT_FOUND`: Not found.'
          headers:
            X-Request-Id:
              $ref: '#/components/headers/RequestId'
            Idempotent-Replayed:
              $ref: '#/components/headers/IdempotentReplayed'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
          x-error-codes:
            - NOT_FOUND
        '406':
          description: '`NOT_ACCEPTABLE`: This endpoint doesn''t offer the format in Accept.'
          headers:
            X-Request-Id:
              $ref: '#/components/headers/RequestId'
            Idempotent-Replayed:
              $ref: '#/components/headers/IdempotentReplayed'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
          x-error-codes:
            - NOT_ACCEPTABLE
        '409':
          description: >-
            `IDEMPOTENCY_IN_PROGRESS`: An earlier request with this
            Idempotency-Key hasn't finished. If this persists, contact support.


            `LEGAL_ENTITY_REQUIRED`: The merchant needs a legal entity with a
            name first.


            `MULTI_ACCOUNT_NOT_ALLOWED`: The merchant already has an active
            account of its own, and may hold only one.
          headers:
            X-Request-Id:
              $ref: '#/components/headers/RequestId'
            Idempotent-Replayed:
              $ref: '#/components/headers/IdempotentReplayed'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
          x-error-codes:
            - IDEMPOTENCY_IN_PROGRESS
            - LEGAL_ENTITY_REQUIRED
            - MULTI_ACCOUNT_NOT_ALLOWED
        '422':
          description: >-
            `IDEMPOTENCY_KEY_REUSED`: This Idempotency-Key was used with a
            different request.
          headers:
            X-Request-Id:
              $ref: '#/components/headers/RequestId'
            Idempotent-Replayed:
              $ref: '#/components/headers/IdempotentReplayed'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
          x-error-codes:
            - IDEMPOTENCY_KEY_REUSED
        '429':
          description: '`RATE_LIMITED`: Too many requests.'
          headers:
            X-Request-Id:
              $ref: '#/components/headers/RequestId'
            Idempotent-Replayed:
              $ref: '#/components/headers/IdempotentReplayed'
            Retry-After:
              $ref: '#/components/headers/RetryAfter'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
          x-error-codes:
            - RATE_LIMITED
        '500':
          description: '`INTERNAL_ERROR`: Something went wrong on our side.'
          headers:
            X-Request-Id:
              $ref: '#/components/headers/RequestId'
            Idempotent-Replayed:
              $ref: '#/components/headers/IdempotentReplayed'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
          x-error-codes:
            - INTERNAL_ERROR
        '503':
          description: '`SERVICE_UNAVAILABLE`: The service is busy. Try again shortly.'
          headers:
            X-Request-Id:
              $ref: '#/components/headers/RequestId'
            Idempotent-Replayed:
              $ref: '#/components/headers/IdempotentReplayed'
            Retry-After:
              $ref: '#/components/headers/RetryAfter'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
          x-error-codes:
            - SERVICE_UNAVAILABLE
components:
  schemas:
    Consent:
      additionalProperties: false
      type: object
      required:
        - is_accepted
        - accepted_at
        - accepted_by
        - accepted_ip
        - wording
        - locale
        - agreements
      properties:
        is_accepted:
          const: true
          type: boolean
        accepted_at:
          format: date-time
          pattern: ^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}(\.\d+)?(Z|[+-]\d{2}:\d{2})$
          type: string
          description: >-
            When the person accepted. Before the agreement took effect, more
            than 5 minutes in the future or more than 30 days old is refused,
            with `CONSENT_ACCEPTED_AT_INVALID`.
        accepted_by:
          additionalProperties: false
          type: object
          required:
            - full_name
            - email
          properties:
            full_name:
              minLength: 1
              maxLength: 200
              pattern: ^[^\x00-\x1F\x7F]*$
              description: On one line, with no control character.
              type: string
            email:
              format: email
              maxLength: 320
              type: string
              pattern: >-
                ^[a-zA-Z0-9.!#$%&'*+/=?^_`{|}~-]+@[a-zA-Z0-9](?:[a-zA-Z0-9-]{0,61}[a-zA-Z0-9])?(?:\.[a-zA-Z0-9](?:[a-zA-Z0-9-]{0,61}[a-zA-Z0-9])?)*$
        accepted_ip:
          anyOf:
            - format: ipv4
              type: string
            - format: ipv6
              type: string
        wording:
          minLength: 1
          maxLength: 10000
          pattern: ^[^\x00-\x08\x0B\x0C\x0E-\x1F\x7F]*$
          description: >-
            The exact text the person saw, with no control character but a line
            break or a tab.
          type: string
        locale:
          pattern: ^[A-Za-z]{2,3}(-[A-Za-z0-9]{1,8})*$
          type: string
          maxLength: 35
        agreements:
          minItems: 1
          maxItems: 7
          type: array
          items:
            $ref: '#/components/schemas/AgreementRequestLink'
    BankAccountFull:
      additionalProperties: false
      type: object
      required:
        - _type
        - _uri
        - _view
        - id
        - created_at
        - updated_at
        - merchant
        - status
        - account_type
        - account_roles
        - currency
        - country
        - account_holder_name
        - bic
        - sort_code
        - routing_number
        - bsb
        - ownership_status
        - ownership_verified_at
        - masked_identifier
        - payment_schemes
        - balance
      properties:
        _type:
          const: bank_account
          type: string
        _uri:
          pattern: ^/
          description: The canonical URI, relative to the version root.
          type: string
        _view:
          const: full
          type: string
        id:
          type: string
        created_at:
          anyOf:
            - format: date-time
              pattern: ^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}(\.\d+)?Z$
              type: string
            - type: 'null'
        updated_at:
          anyOf:
            - format: date-time
              pattern: ^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}(\.\d+)?Z$
              type: string
            - type: 'null'
        merchant:
          $ref: '#/components/schemas/MerchantLink'
        status:
          type: string
          enum:
            - active
            - inactive
          description: >-
            `active` can be used in its roles. That alone doesn't mean a payout
            will reach it: see `ownership_status`, and Quidkey registers a new
            `owned` account with the providers that pay it without waiting for
            them, so a payout to one that hasn't registered fails. `inactive` is
            final, and a new account is the way back.
        account_type:
          type: string
          enum:
            - owned
            - virtual
          description: >-
            `owned` is the merchant's own account elsewhere. `virtual` is held
            for the merchant by Quidkey.
        account_roles:
          type: array
          items:
            type: string
            enum:
              - payment
              - payout
              - refund
          description: >-
            What this account can be used for, which isn't that it's in use. For
            each currency Quidkey keeps at most one route for live payment
            transactions and one for payouts, each naming one account, and only
            that account is used. `payment`: a route can send payment
            transactions here. `payout`: a route can send payouts here, which
            only an `owned` account can have. `refund`: funds refunds, and holds
            what's retained from payouts for them. An account added by a bank
            link is `payout` only.
        currency:
          pattern: ^[A-Z]{3}$
          type: string
          description: >-
            A route sends this account money only in this currency. A payment
            transaction through a virtual account with no `payout` account in
            its own currency is converted, as the merchant's `home_currency`
            says.
        country:
          anyOf:
            - pattern: ^[A-Z]{2}$
              type: string
            - type: 'null'
          description: The account's country. `null` when none is held.
        account_holder_name:
          anyOf:
            - type: string
            - type: 'null'
        bic:
          anyOf:
            - type: string
            - type: 'null'
          description: Identifies a bank, not an account.
        sort_code:
          anyOf:
            - type: string
            - type: 'null'
        routing_number:
          anyOf:
            - type: string
            - type: 'null'
        bsb:
          anyOf:
            - type: string
            - type: 'null'
        ownership_status:
          type: string
          enum:
            - pending
            - verified
            - not_applicable
          description: >-
            `pending`: this `owned` account is `pending` until Quidkey verifies
            it's the merchant's. While Quidkey's verification hold is on, a
            payout to it waits and a live payment transaction into it is
            refused, with `LIVE_PAYMENTS_NOT_ALLOWED`. A merchant can go live
            with one, and uploads a statement for it in Quidkey's Console, as
            this API takes none. `verified`: Quidkey takes the account as the
            merchant's. `not_applicable`: a `virtual` account, which Quidkey
            opens itself.
        ownership_verified_at:
          anyOf:
            - format: date-time
              pattern: ^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}(\.\d+)?Z$
              type: string
            - type: 'null'
          description: When Quidkey took the account as verified. Set once.
        masked_identifier:
          anyOf:
            - type: string
            - type: 'null'
          description: >-
            The end of the account's number behind `****`, or of its other
            identifier on an account with no number. With its spaces and
            punctuation gone, it shows at most the last 4 characters and at most
            half of it. It helps tell accounts apart, though two can share one.
            `null` where that leaves 4 characters or fewer, or where Quidkey
            holds none. The number itself is never returned.
        payment_schemes:
          maxItems: 20
          type: array
          items:
            additionalProperties: false
            type: object
            required:
              - _type
              - id
              - is_active
            properties:
              _type:
                const: payment_scheme
                type: string
              id:
                type: string
              is_active:
                type: boolean
            x-link-target:
              resource: payment_scheme
              kind: resource
              is_published: false
          description: >-
            `id` is the scheme's stable code, such as `faster_payments`.
            `is_active` says whether Quidkey offers this scheme for a payment
            transaction routed to this account. A false doesn't by itself refuse
            a payment transaction, and it says nothing while the account is
            `inactive`. It has no part in how a payout reaches the account.
            Empty where none is attached, as on an account added by a bank link.
        balance:
          anyOf:
            - $ref: '#/components/schemas/BalanceSubResourceLink'
            - type: 'null'
          description: Set on an active `virtual` account, and `null` otherwise.
    NotIncludedEntry:
      additionalProperties: false
      type: object
      required:
        - link
        - reason
      properties:
        link:
          $ref: '#/components/schemas/AnyLink'
        reason:
          type: string
          enum:
            - no_permission
            - not_published
          description: >-
            Why this link has no entity.


            - `no_permission`: This credential can't read it. Fetching it
            answers 403, or 404 where a 403 would reveal that it exists.

            - `not_published`: The API doesn't show it: a type it doesn't
            publish, or a record it doesn't show on a type it does, such as a
            failed payout. Fetching it, where it has a URI, answers 404.
    Error:
      additionalProperties: false
      type: object
      required:
        - error
      properties:
        error:
          additionalProperties: false
          type: object
          required:
            - code
            - message
            - details
            - retryable
            - request_id
          properties:
            code:
              description: Branch on this. New codes can appear.
              type: string
            message:
              description: For people. It can change.
              type: string
            details:
              type: array
              items:
                $ref: '#/components/schemas/ErrorDetail'
            retryable:
              description: >-
                Whether sending the same request again unchanged, after a wait,
                can succeed with nothing else changing.
              type: boolean
            request_id:
              description: Quote this to support.
              type: string
    AgreementRequestLink:
      additionalProperties: false
      type: object
      required:
        - id
      properties:
        id:
          minLength: 1
          maxLength: 100
          type: string
        _link:
          pattern: ^/
          type: string
        _type:
          const: agreement
          type: string
      x-link-target:
        resource: agreement
        kind: request
        is_published: true
    MerchantLink:
      additionalProperties: false
      type: object
      required:
        - _link
        - _type
        - id
      properties:
        _link:
          pattern: ^/
          type: string
        _type:
          const: merchant
          type: string
        id:
          type: string
      x-link-target:
        resource: merchant
        kind: resource
        is_published: true
        views:
          - full
    BalanceSubResourceLink:
      additionalProperties: false
      type: object
      required:
        - _link
        - _type
        - id
      properties:
        _link:
          pattern: ^/
          type: string
        _type:
          const: balance
          type: string
        id:
          type: string
      x-link-target:
        resource: balance
        kind: singleton
        is_published: true
        views:
          - full
    AnyLink:
      anyOf:
        - additionalProperties: false
          type: object
          required:
            - _link
            - _type
            - id
          properties:
            _link:
              pattern: ^/
              type: string
            _type:
              type: string
            id:
              type: string
        - additionalProperties: false
          type: object
          required:
            - _type
            - id
          properties:
            _type:
              type: string
            id:
              type: string
      x-link-target:
        resource: any
        kind: any
        is_published: true
    ErrorDetail:
      anyOf:
        - additionalProperties: false
          type: object
          required:
            - field
            - message
          properties:
            field:
              type: string
            message:
              type: string
        - additionalProperties: false
          type: object
          required:
            - required_actions
            - message
          properties:
            required_actions:
              description: The `required_actions` codes holding this back.
              type: array
              items:
                type: string
            message:
              type: string
        - additionalProperties: false
          type: object
          required:
            - available_percent
            - message
          properties:
            available_percent:
              $ref: '#/components/schemas/Percent'
            message:
              type: string
        - additionalProperties: false
          type: object
          required:
            - agreement
            - message
          properties:
            agreement:
              $ref: '#/components/schemas/AgreementLink'
            message:
              type: string
        - additionalProperties: false
          type: object
          required:
            - agreement
            - current_agreement
            - message
          properties:
            agreement:
              $ref: '#/components/schemas/AgreementLink'
            current_agreement:
              $ref: '#/components/schemas/AgreementLink'
            message:
              type: string
        - additionalProperties: false
          type: object
          required:
            - legal_entity
            - message
          properties:
            legal_entity:
              $ref: '#/components/schemas/LegalEntityLink'
            message:
              type: string
    Percent:
      pattern: ^\d+(\.\d+)?$
      description: 'A percentage as a decimal string: `"25.00"` is 25%.'
      type: string
    AgreementLink:
      additionalProperties: false
      type: object
      required:
        - _link
        - _type
        - id
      properties:
        _link:
          pattern: ^/
          type: string
        _type:
          const: agreement
          type: string
        id:
          type: string
      x-link-target:
        resource: agreement
        kind: resource
        is_published: true
        views:
          - full
    LegalEntityLink:
      additionalProperties: false
      type: object
      required:
        - _link
        - _type
        - id
      properties:
        _link:
          pattern: ^/
          type: string
        _type:
          const: legal_entity
          type: string
        id:
          type: string
      x-link-target:
        resource: legal_entity
        kind: resource
        is_published: true
        views:
          - full
  headers:
    RequestId:
      description: Identifies this request. Quote it to support.
      schema:
        type: string
    IdempotentReplayed:
      description: '`true` on a retry that answers with the first attempt''s outcome.'
      schema:
        type: string
        enum:
          - 'true'
    RetryAfter:
      description: How many seconds to wait before retrying.
      schema:
        minimum: 0
        type: integer
  securitySchemes:
    bearer:
      type: http
      scheme: bearer

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.