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

# Create Connection Invitation

> Create an invitation that lets an external contributor connect a new utility account to the specified company. The response includes an `invitationUrl` to send to the contributor. Supports optional email restrictions, expiration, usage limits, and pre-filled form data.



## OpenAPI

````yaml /api-reference/openapi-v2-2.json post /invitation/company/{company_id}
openapi: 3.1.0
info:
  title: Nectar API Documentation
  version: 1.0.0 (v1)
  description: >-
    Complete API documentation for v2.2 endpoints to managing companies, sites,
    data, and documents
servers:
  - url: https://external.nectarclimate.com/v2.2
    description: Nectar API Server
security: []
paths:
  /invitation/company/{company_id}:
    post:
      tags:
        - Invitations
      summary: Create Connection Invitation
      description: >-
        Create an invitation that lets an external contributor connect a new
        utility account to the specified company. The response includes an
        `invitationUrl` to send to the contributor. Supports optional email
        restrictions, expiration, usage limits, and pre-filled form data.
      operationId: invitation_company_create
      parameters:
        - in: path
          name: company_id
          schema:
            type: string
            format: uuid
          description: ID of the company to create the invitation for.
          required: true
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ExternalInvitationCreateRequest'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/ExternalInvitationCreateRequest'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/ExternalInvitationCreateRequest'
      responses:
        '201':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ExternalInvitation'
          description: ''
        '400':
          description: Validation error.
        '403':
          description: 'Forbidden: insufficient permissions or inaccessible sites.'
        '404':
          description: Company not found.
      security:
        - ExternalAuthentication: []
components:
  schemas:
    ExternalInvitationCreateRequest:
      type: object
      description: >-
        Request body for creating an invitation that lets an external
        contributor connect a utility account.
      properties:
        allowedEmails:
          type: array
          items:
            type: string
            format: email
            minLength: 1
          description: >-
            Restrict the invitation to these email addresses. If empty, anyone
            with the link can use it. When set, the recipient must verify their
            email before proceeding.
        expiresInSeconds:
          type: integer
          minimum: 60
          description: >-
            Number of seconds until the invitation expires. Omit to create a
            non-expiring invitation.
        maxUses:
          type: integer
          minimum: 1
          description: >-
            Maximum number of times this invitation can be used to create a
            connection. Omit for unlimited uses.
        sendEmail:
          type: boolean
          default: false
          description: >-
            If true and allowedEmails is non-empty, sends the invitation link to
            each email address. If false, the link is returned in the response
            for manual distribution.
        prefill:
          allOf:
            - $ref: '#/components/schemas/ExternalInvitationPrefillRequest'
          description: Optional data to pre-populate in the connection form.
    ExternalInvitation:
      type: object
      description: >-
        An invitation that grants an external contributor access to create or
        update a connection.
      properties:
        id:
          type: string
          format: uuid
          description: Unique identifier of the invitation.
        token:
          type: string
          description: >-
            Opaque token used in the invitation URL. This is the value embedded
            in invitationUrl.
        invitationType:
          type: string
          description: >-
            CREATE_CONNECTION — invitation to connect a new utility account.
            EDIT_CONNECTION — invitation to update credentials on an existing
            connection.
        status:
          type: string
          description: >-
            ACTIVE — can still be used. EXPIRED — past its expiration time.
            REVOKED — manually invalidated. FULFILLED — reached its maximum use
            count.
        invitationUrl:
          type: string
          description: >-
            Full URL to send to the recipient. Opening this link takes them to
            the connection form.
        companyId:
          type: string
          format: uuid
          description: The company this invitation belongs to.
        connectionId:
          type:
            - string
            - 'null'
          format: uuid
          description: >-
            For EDIT_CONNECTION invitations, the ID of the connection to update.
            Null for CREATE_CONNECTION invitations.
        allowedEmails:
          type: array
          items:
            type: string
            format: email
          description: >-
            Email addresses allowed to use this invitation. Empty list means
            anyone with the link can use it.
        expiresAt:
          type:
            - string
            - 'null'
          format: date-time
          description: When the invitation expires. Null means it never expires.
        maxUses:
          type:
            - integer
            - 'null'
          description: >-
            Maximum number of times this invitation can be used. Null means
            unlimited.
        useCount:
          type: integer
          description: How many times this invitation has been used so far.
        created:
          type: string
          format: date-time
          description: When the invitation was created.
        createdAt:
          type: string
          format: date-time
          description: Deprecated. Use 'created' instead.
        prefill:
          oneOf:
            - $ref: '#/components/schemas/ExternalInvitationPrefill'
            - type: 'null'
          description: >-
            Pre-populated form data for CREATE_CONNECTION invitations. Empty
            object for EDIT_CONNECTION invitations.
        createdConnections:
          type: array
          items:
            $ref: '#/components/schemas/ExternalCreatedConnectionRef'
          description: >-
            Connections that were created by recipients of this invitation. Only
            populated for CREATE_CONNECTION invitations; empty list for
            EDIT_CONNECTION.
      required:
        - allowedEmails
        - companyId
        - connectionId
        - created
        - createdAt
        - createdConnections
        - expiresAt
        - id
        - invitationType
        - invitationUrl
        - maxUses
        - prefill
        - status
        - token
        - useCount
    ExternalInvitationPrefillRequest:
      type: object
      description: >-
        Optional data to pre-populate in the connection form when the recipient
        opens the invitation link.
      properties:
        datasourceId:
          type: string
          format: uuid
          description: >-
            ID of a known utility provider to lock into the connection form. Use
            GET /v2/datasource to discover IDs. Mutually exclusive with `url`.
        url:
          type: string
          format: uri
          minLength: 1
          description: >-
            Web address of the utility company's website to pre-populate in the
            connection form. Legacy option kept for backwards compatibility;
            prefer `datasourceId` when the provider already exists in the
            catalog. Mutually exclusive with `datasourceId`.
          maxLength: 5000
        initialSites:
          type: array
          items:
            type: string
            format: uuid
          description: >-
            Site IDs to pre-select. Each site must belong to the invitation's
            company and be accessible by the API key.
        utilityTypes:
          type: array
          items:
            $ref: '#/components/schemas/DataSourceTypeEnum'
          description: Utility types to pre-select (e.g. ELECTRICITY, GAS, WATER).
        country:
          allOf:
            - $ref: '#/components/schemas/CountryEnum'
          description: |-
            Country of the utility company to pre-populate.

            * `AF` - Af
            * `AL` - Al
            * `DZ` - Dz
            * `AS` - As
            * `AD` - Ad
            * `AO` - Ao
            * `AI` - Ai
            * `AQ` - Aq
            * `AG` - Ag
            * `AR` - Ar
            * `AM` - Am
            * `AW` - Aw
            * `AU` - Au
            * `AT` - At
            * `AZ` - Az
            * `BS` - Bs
            * `BH` - Bh
            * `BD` - Bd
            * `BB` - Bb
            * `BY` - By
            * `BE` - Be
            * `BZ` - Bz
            * `BJ` - Bj
            * `BM` - Bm
            * `BT` - Bt
            * `BO` - Bo
            * `BQ` - Bq
            * `BA` - Ba
            * `BW` - Bw
            * `BV` - Bv
            * `BR` - Br
            * `IO` - Io
            * `BN` - Bn
            * `BG` - Bg
            * `BF` - Bf
            * `BI` - Bi
            * `KH` - Kh
            * `CM` - Cm
            * `CA` - Ca
            * `CV` - Cv
            * `KY` - Ky
            * `CF` - Cf
            * `TD` - Td
            * `CL` - Cl
            * `CN` - Cn
            * `CX` - Cx
            * `CC` - Cc
            * `CO` - Co
            * `KM` - Km
            * `CG` - Cg
            * `CD` - Cd
            * `CK` - Ck
            * `CR` - Cr
            * `HR` - Hr
            * `CU` - Cu
            * `CW` - Cw
            * `CY` - Cy
            * `CZ` - Cz
            * `CI` - Ci
            * `DK` - Dk
            * `DJ` - Dj
            * `DM` - Dm
            * `DO` - Do
            * `EC` - Ec
            * `EG` - Eg
            * `SV` - Sv
            * `GQ` - Gq
            * `ER` - Er
            * `EE` - Ee
            * `ET` - Et
            * `FK` - Fk
            * `FO` - Fo
            * `FJ` - Fj
            * `FI` - Fi
            * `FR` - Fr
            * `GF` - Gf
            * `PF` - Pf
            * `TF` - Tf
            * `GA` - Ga
            * `GM` - Gm
            * `GE` - Ge
            * `DE` - De
            * `GH` - Gh
            * `GI` - Gi
            * `GR` - Gr
            * `GL` - Gl
            * `GD` - Gd
            * `GP` - Gp
            * `GU` - Gu
            * `GT` - Gt
            * `GG` - Gg
            * `GN` - Gn
            * `GW` - Gw
            * `GY` - Gy
            * `HT` - Ht
            * `HM` - Hm
            * `VA` - Va
            * `HN` - Hn
            * `HK` - Hk
            * `HU` - Hu
            * `IS` - Is
            * `IN` - In
            * `ID` - Id
            * `IR` - Ir
            * `IQ` - Iq
            * `IE` - Ie
            * `IM` - Im
            * `IL` - Il
            * `IT` - It
            * `JM` - Jm
            * `JP` - Jp
            * `JE` - Je
            * `JO` - Jo
            * `KZ` - Kz
            * `KE` - Ke
            * `KI` - Ki
            * `KP` - Kp
            * `KR` - Kr
            * `KW` - Kw
            * `KG` - Kg
            * `LA` - La
            * `LV` - Lv
            * `LB` - Lb
            * `LS` - Ls
            * `LR` - Lr
            * `LY` - Ly
            * `LI` - Li
            * `LT` - Lt
            * `LU` - Lu
            * `MO` - Mo
            * `MK` - Mk
            * `MG` - Mg
            * `MW` - Mw
            * `MY` - My
            * `MV` - Mv
            * `ML` - Ml
            * `MT` - Mt
            * `MH` - Mh
            * `MQ` - Mq
            * `MR` - Mr
            * `MU` - Mu
            * `YT` - Yt
            * `MX` - Mx
            * `FM` - Fm
            * `MD` - Md
            * `MC` - Mc
            * `MN` - Mn
            * `ME` - Me
            * `MS` - Ms
            * `MA` - Ma
            * `MZ` - Mz
            * `MM` - Mm
            * `NA` - Na
            * `NR` - Nr
            * `NP` - Np
            * `NL` - Nl
            * `NC` - Nc
            * `NZ` - Nz
            * `NI` - Ni
            * `NE` - Ne
            * `NG` - Ng
            * `NU` - Nu
            * `NF` - Nf
            * `MP` - Mp
            * `NO` - No
            * `OM` - Om
            * `PK` - Pk
            * `PW` - Pw
            * `PS` - Ps
            * `PA` - Pa
            * `PG` - Pg
            * `PY` - Py
            * `PE` - Pe
            * `PH` - Ph
            * `PN` - Pn
            * `PL` - Pl
            * `PT` - Pt
            * `PR` - Pr
            * `QA` - Qa
            * `RO` - Ro
            * `RU` - Ru
            * `RW` - Rw
            * `RE` - Re
            * `BL` - Bl
            * `SH` - Sh
            * `KN` - Kn
            * `LC` - Lc
            * `MF` - Mf
            * `PM` - Pm
            * `VC` - Vc
            * `WS` - Ws
            * `SM` - Sm
            * `ST` - St
            * `SA` - Sa
            * `SN` - Sn
            * `RS` - Rs
            * `SC` - Sc
            * `SL` - Sl
            * `SG` - Sg
            * `SX` - Sx
            * `SK` - Sk
            * `SI` - Si
            * `SB` - Sb
            * `SO` - So
            * `ZA` - Za
            * `GS` - Gs
            * `SS` - Ss
            * `ES` - Es
            * `LK` - Lk
            * `SD` - Sd
            * `SR` - Sr
            * `SJ` - Sj
            * `SZ` - Sz
            * `SE` - Se
            * `CH` - Ch
            * `SY` - Sy
            * `TW` - Tw
            * `TJ` - Tj
            * `TZ` - Tz
            * `TH` - Th
            * `TL` - Tl
            * `TG` - Tg
            * `TK` - Tk
            * `TO` - To
            * `TT` - Tt
            * `TN` - Tn
            * `TR` - Tr
            * `TM` - Tm
            * `TC` - Tc
            * `TV` - Tv
            * `UG` - Ug
            * `UA` - Ua
            * `AE` - Ae
            * `GB` - Gb
            * `US` - Us
            * `UM` - Um
            * `UY` - Uy
            * `UZ` - Uz
            * `VU` - Vu
            * `VE` - Ve
            * `VN` - Vn
            * `VG` - Vg
            * `VI` - Vi
            * `WF` - Wf
            * `EH` - Eh
            * `YE` - Ye
            * `ZM` - Zm
            * `ZW` - Zw
            * `AX` - Ax
        connectionOwnerEmail:
          type: string
          format: email
          minLength: 1
          description: >-
            Email address of the person responsible for this connection. Shown
            in the connection form and stored on the resulting connection.
        dataCollectionStartDate:
          type: string
          format: date
          description: Earliest date from which to collect utility data.
        externalId:
          type: string
          description: >-
            Your own identifier for the connection that will be created. Stored
            on the resulting connection and returned in all connection
            responses.
          maxLength: 200
    ExternalInvitationPrefill:
      type: object
      description: >-
        Optional data to pre-populate in the connection form when the recipient
        opens the invitation link.
      properties:
        datasourceId:
          type: string
          format: uuid
          description: >-
            ID of a known utility provider to lock into the connection form. Use
            GET /v2/datasource to discover IDs. Mutually exclusive with `url`.
        url:
          type: string
          format: uri
          description: >-
            Web address of the utility company's website to pre-populate in the
            connection form. Legacy option kept for backwards compatibility;
            prefer `datasourceId` when the provider already exists in the
            catalog. Mutually exclusive with `datasourceId`.
          maxLength: 5000
        initialSites:
          type: array
          items:
            type: string
            format: uuid
          description: >-
            Site IDs to pre-select. Each site must belong to the invitation's
            company and be accessible by the API key.
        utilityTypes:
          type: array
          items:
            $ref: '#/components/schemas/DataSourceTypeEnum'
          description: Utility types to pre-select (e.g. ELECTRICITY, GAS, WATER).
        country:
          allOf:
            - $ref: '#/components/schemas/CountryEnum'
          description: |-
            Country of the utility company to pre-populate.

            * `AF` - Af
            * `AL` - Al
            * `DZ` - Dz
            * `AS` - As
            * `AD` - Ad
            * `AO` - Ao
            * `AI` - Ai
            * `AQ` - Aq
            * `AG` - Ag
            * `AR` - Ar
            * `AM` - Am
            * `AW` - Aw
            * `AU` - Au
            * `AT` - At
            * `AZ` - Az
            * `BS` - Bs
            * `BH` - Bh
            * `BD` - Bd
            * `BB` - Bb
            * `BY` - By
            * `BE` - Be
            * `BZ` - Bz
            * `BJ` - Bj
            * `BM` - Bm
            * `BT` - Bt
            * `BO` - Bo
            * `BQ` - Bq
            * `BA` - Ba
            * `BW` - Bw
            * `BV` - Bv
            * `BR` - Br
            * `IO` - Io
            * `BN` - Bn
            * `BG` - Bg
            * `BF` - Bf
            * `BI` - Bi
            * `KH` - Kh
            * `CM` - Cm
            * `CA` - Ca
            * `CV` - Cv
            * `KY` - Ky
            * `CF` - Cf
            * `TD` - Td
            * `CL` - Cl
            * `CN` - Cn
            * `CX` - Cx
            * `CC` - Cc
            * `CO` - Co
            * `KM` - Km
            * `CG` - Cg
            * `CD` - Cd
            * `CK` - Ck
            * `CR` - Cr
            * `HR` - Hr
            * `CU` - Cu
            * `CW` - Cw
            * `CY` - Cy
            * `CZ` - Cz
            * `CI` - Ci
            * `DK` - Dk
            * `DJ` - Dj
            * `DM` - Dm
            * `DO` - Do
            * `EC` - Ec
            * `EG` - Eg
            * `SV` - Sv
            * `GQ` - Gq
            * `ER` - Er
            * `EE` - Ee
            * `ET` - Et
            * `FK` - Fk
            * `FO` - Fo
            * `FJ` - Fj
            * `FI` - Fi
            * `FR` - Fr
            * `GF` - Gf
            * `PF` - Pf
            * `TF` - Tf
            * `GA` - Ga
            * `GM` - Gm
            * `GE` - Ge
            * `DE` - De
            * `GH` - Gh
            * `GI` - Gi
            * `GR` - Gr
            * `GL` - Gl
            * `GD` - Gd
            * `GP` - Gp
            * `GU` - Gu
            * `GT` - Gt
            * `GG` - Gg
            * `GN` - Gn
            * `GW` - Gw
            * `GY` - Gy
            * `HT` - Ht
            * `HM` - Hm
            * `VA` - Va
            * `HN` - Hn
            * `HK` - Hk
            * `HU` - Hu
            * `IS` - Is
            * `IN` - In
            * `ID` - Id
            * `IR` - Ir
            * `IQ` - Iq
            * `IE` - Ie
            * `IM` - Im
            * `IL` - Il
            * `IT` - It
            * `JM` - Jm
            * `JP` - Jp
            * `JE` - Je
            * `JO` - Jo
            * `KZ` - Kz
            * `KE` - Ke
            * `KI` - Ki
            * `KP` - Kp
            * `KR` - Kr
            * `KW` - Kw
            * `KG` - Kg
            * `LA` - La
            * `LV` - Lv
            * `LB` - Lb
            * `LS` - Ls
            * `LR` - Lr
            * `LY` - Ly
            * `LI` - Li
            * `LT` - Lt
            * `LU` - Lu
            * `MO` - Mo
            * `MK` - Mk
            * `MG` - Mg
            * `MW` - Mw
            * `MY` - My
            * `MV` - Mv
            * `ML` - Ml
            * `MT` - Mt
            * `MH` - Mh
            * `MQ` - Mq
            * `MR` - Mr
            * `MU` - Mu
            * `YT` - Yt
            * `MX` - Mx
            * `FM` - Fm
            * `MD` - Md
            * `MC` - Mc
            * `MN` - Mn
            * `ME` - Me
            * `MS` - Ms
            * `MA` - Ma
            * `MZ` - Mz
            * `MM` - Mm
            * `NA` - Na
            * `NR` - Nr
            * `NP` - Np
            * `NL` - Nl
            * `NC` - Nc
            * `NZ` - Nz
            * `NI` - Ni
            * `NE` - Ne
            * `NG` - Ng
            * `NU` - Nu
            * `NF` - Nf
            * `MP` - Mp
            * `NO` - No
            * `OM` - Om
            * `PK` - Pk
            * `PW` - Pw
            * `PS` - Ps
            * `PA` - Pa
            * `PG` - Pg
            * `PY` - Py
            * `PE` - Pe
            * `PH` - Ph
            * `PN` - Pn
            * `PL` - Pl
            * `PT` - Pt
            * `PR` - Pr
            * `QA` - Qa
            * `RO` - Ro
            * `RU` - Ru
            * `RW` - Rw
            * `RE` - Re
            * `BL` - Bl
            * `SH` - Sh
            * `KN` - Kn
            * `LC` - Lc
            * `MF` - Mf
            * `PM` - Pm
            * `VC` - Vc
            * `WS` - Ws
            * `SM` - Sm
            * `ST` - St
            * `SA` - Sa
            * `SN` - Sn
            * `RS` - Rs
            * `SC` - Sc
            * `SL` - Sl
            * `SG` - Sg
            * `SX` - Sx
            * `SK` - Sk
            * `SI` - Si
            * `SB` - Sb
            * `SO` - So
            * `ZA` - Za
            * `GS` - Gs
            * `SS` - Ss
            * `ES` - Es
            * `LK` - Lk
            * `SD` - Sd
            * `SR` - Sr
            * `SJ` - Sj
            * `SZ` - Sz
            * `SE` - Se
            * `CH` - Ch
            * `SY` - Sy
            * `TW` - Tw
            * `TJ` - Tj
            * `TZ` - Tz
            * `TH` - Th
            * `TL` - Tl
            * `TG` - Tg
            * `TK` - Tk
            * `TO` - To
            * `TT` - Tt
            * `TN` - Tn
            * `TR` - Tr
            * `TM` - Tm
            * `TC` - Tc
            * `TV` - Tv
            * `UG` - Ug
            * `UA` - Ua
            * `AE` - Ae
            * `GB` - Gb
            * `US` - Us
            * `UM` - Um
            * `UY` - Uy
            * `UZ` - Uz
            * `VU` - Vu
            * `VE` - Ve
            * `VN` - Vn
            * `VG` - Vg
            * `VI` - Vi
            * `WF` - Wf
            * `EH` - Eh
            * `YE` - Ye
            * `ZM` - Zm
            * `ZW` - Zw
            * `AX` - Ax
        connectionOwnerEmail:
          type: string
          format: email
          description: >-
            Email address of the person responsible for this connection. Shown
            in the connection form and stored on the resulting connection.
        dataCollectionStartDate:
          type: string
          format: date
          description: Earliest date from which to collect utility data.
        externalId:
          type: string
          description: >-
            Your own identifier for the connection that will be created. Stored
            on the resulting connection and returned in all connection
            responses.
          maxLength: 200
    ExternalCreatedConnectionRef:
      type: object
      description: >-
        A connection that was created when someone used a CREATE_CONNECTION
        invitation.
      properties:
        id:
          type: string
          format: uuid
          description: Unique identifier of the connection.
        datasourceName:
          type:
            - string
            - 'null'
          description: Name of the utility provider, or null if not yet resolved.
        status:
          type: string
          description: Current connection status (e.g. CONNECTED, PENDING, ERROR).
        created:
          type: string
          format: date-time
          description: When this connection was created.
      required:
        - created
        - datasourceName
        - id
        - status
    DataSourceTypeEnum:
      enum:
        - ELECTRICITY
        - GAS
        - WATER
        - DISTRICT
        - WASTE
        - FUEL
        - MISC
        - REFRIGERANT
        - SOLAR
        - TELECOM
      type: string
      description: |-
        * `ELECTRICITY` - Electricity
        * `GAS` - Gas
        * `WATER` - Water
        * `DISTRICT` - District
        * `WASTE` - Waste
        * `FUEL` - Fuel
        * `MISC` - Misc
        * `REFRIGERANT` - Refrigerant
        * `SOLAR` - Solar
        * `TELECOM` - Telecom
    CountryEnum:
      enum:
        - AF
        - 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
        - BQ
        - BA
        - BW
        - BV
        - BR
        - IO
        - BN
        - BG
        - BF
        - BI
        - KH
        - CM
        - CA
        - CV
        - KY
        - CF
        - TD
        - CL
        - CN
        - CX
        - CC
        - CO
        - KM
        - CG
        - CD
        - CK
        - CR
        - HR
        - CU
        - CW
        - CY
        - CZ
        - CI
        - DK
        - DJ
        - DM
        - DO
        - EC
        - EG
        - SV
        - GQ
        - ER
        - EE
        - 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
        - MK
        - 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
        - NC
        - NZ
        - NI
        - NE
        - NG
        - NU
        - NF
        - MP
        - 'NO'
        - OM
        - PK
        - PW
        - PS
        - PA
        - PG
        - PY
        - PE
        - PH
        - PN
        - PL
        - PT
        - PR
        - QA
        - RO
        - RU
        - RW
        - RE
        - BL
        - SH
        - KN
        - LC
        - MF
        - PM
        - VC
        - WS
        - SM
        - ST
        - SA
        - SN
        - RS
        - SC
        - SL
        - SG
        - SX
        - SK
        - SI
        - SB
        - SO
        - ZA
        - GS
        - SS
        - ES
        - LK
        - SD
        - SR
        - SJ
        - SZ
        - 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
        - AX
      type: string
      description: |-
        * `AF` - Af
        * `AL` - Al
        * `DZ` - Dz
        * `AS` - As
        * `AD` - Ad
        * `AO` - Ao
        * `AI` - Ai
        * `AQ` - Aq
        * `AG` - Ag
        * `AR` - Ar
        * `AM` - Am
        * `AW` - Aw
        * `AU` - Au
        * `AT` - At
        * `AZ` - Az
        * `BS` - Bs
        * `BH` - Bh
        * `BD` - Bd
        * `BB` - Bb
        * `BY` - By
        * `BE` - Be
        * `BZ` - Bz
        * `BJ` - Bj
        * `BM` - Bm
        * `BT` - Bt
        * `BO` - Bo
        * `BQ` - Bq
        * `BA` - Ba
        * `BW` - Bw
        * `BV` - Bv
        * `BR` - Br
        * `IO` - Io
        * `BN` - Bn
        * `BG` - Bg
        * `BF` - Bf
        * `BI` - Bi
        * `KH` - Kh
        * `CM` - Cm
        * `CA` - Ca
        * `CV` - Cv
        * `KY` - Ky
        * `CF` - Cf
        * `TD` - Td
        * `CL` - Cl
        * `CN` - Cn
        * `CX` - Cx
        * `CC` - Cc
        * `CO` - Co
        * `KM` - Km
        * `CG` - Cg
        * `CD` - Cd
        * `CK` - Ck
        * `CR` - Cr
        * `HR` - Hr
        * `CU` - Cu
        * `CW` - Cw
        * `CY` - Cy
        * `CZ` - Cz
        * `CI` - Ci
        * `DK` - Dk
        * `DJ` - Dj
        * `DM` - Dm
        * `DO` - Do
        * `EC` - Ec
        * `EG` - Eg
        * `SV` - Sv
        * `GQ` - Gq
        * `ER` - Er
        * `EE` - Ee
        * `ET` - Et
        * `FK` - Fk
        * `FO` - Fo
        * `FJ` - Fj
        * `FI` - Fi
        * `FR` - Fr
        * `GF` - Gf
        * `PF` - Pf
        * `TF` - Tf
        * `GA` - Ga
        * `GM` - Gm
        * `GE` - Ge
        * `DE` - De
        * `GH` - Gh
        * `GI` - Gi
        * `GR` - Gr
        * `GL` - Gl
        * `GD` - Gd
        * `GP` - Gp
        * `GU` - Gu
        * `GT` - Gt
        * `GG` - Gg
        * `GN` - Gn
        * `GW` - Gw
        * `GY` - Gy
        * `HT` - Ht
        * `HM` - Hm
        * `VA` - Va
        * `HN` - Hn
        * `HK` - Hk
        * `HU` - Hu
        * `IS` - Is
        * `IN` - In
        * `ID` - Id
        * `IR` - Ir
        * `IQ` - Iq
        * `IE` - Ie
        * `IM` - Im
        * `IL` - Il
        * `IT` - It
        * `JM` - Jm
        * `JP` - Jp
        * `JE` - Je
        * `JO` - Jo
        * `KZ` - Kz
        * `KE` - Ke
        * `KI` - Ki
        * `KP` - Kp
        * `KR` - Kr
        * `KW` - Kw
        * `KG` - Kg
        * `LA` - La
        * `LV` - Lv
        * `LB` - Lb
        * `LS` - Ls
        * `LR` - Lr
        * `LY` - Ly
        * `LI` - Li
        * `LT` - Lt
        * `LU` - Lu
        * `MO` - Mo
        * `MK` - Mk
        * `MG` - Mg
        * `MW` - Mw
        * `MY` - My
        * `MV` - Mv
        * `ML` - Ml
        * `MT` - Mt
        * `MH` - Mh
        * `MQ` - Mq
        * `MR` - Mr
        * `MU` - Mu
        * `YT` - Yt
        * `MX` - Mx
        * `FM` - Fm
        * `MD` - Md
        * `MC` - Mc
        * `MN` - Mn
        * `ME` - Me
        * `MS` - Ms
        * `MA` - Ma
        * `MZ` - Mz
        * `MM` - Mm
        * `NA` - Na
        * `NR` - Nr
        * `NP` - Np
        * `NL` - Nl
        * `NC` - Nc
        * `NZ` - Nz
        * `NI` - Ni
        * `NE` - Ne
        * `NG` - Ng
        * `NU` - Nu
        * `NF` - Nf
        * `MP` - Mp
        * `NO` - No
        * `OM` - Om
        * `PK` - Pk
        * `PW` - Pw
        * `PS` - Ps
        * `PA` - Pa
        * `PG` - Pg
        * `PY` - Py
        * `PE` - Pe
        * `PH` - Ph
        * `PN` - Pn
        * `PL` - Pl
        * `PT` - Pt
        * `PR` - Pr
        * `QA` - Qa
        * `RO` - Ro
        * `RU` - Ru
        * `RW` - Rw
        * `RE` - Re
        * `BL` - Bl
        * `SH` - Sh
        * `KN` - Kn
        * `LC` - Lc
        * `MF` - Mf
        * `PM` - Pm
        * `VC` - Vc
        * `WS` - Ws
        * `SM` - Sm
        * `ST` - St
        * `SA` - Sa
        * `SN` - Sn
        * `RS` - Rs
        * `SC` - Sc
        * `SL` - Sl
        * `SG` - Sg
        * `SX` - Sx
        * `SK` - Sk
        * `SI` - Si
        * `SB` - Sb
        * `SO` - So
        * `ZA` - Za
        * `GS` - Gs
        * `SS` - Ss
        * `ES` - Es
        * `LK` - Lk
        * `SD` - Sd
        * `SR` - Sr
        * `SJ` - Sj
        * `SZ` - Sz
        * `SE` - Se
        * `CH` - Ch
        * `SY` - Sy
        * `TW` - Tw
        * `TJ` - Tj
        * `TZ` - Tz
        * `TH` - Th
        * `TL` - Tl
        * `TG` - Tg
        * `TK` - Tk
        * `TO` - To
        * `TT` - Tt
        * `TN` - Tn
        * `TR` - Tr
        * `TM` - Tm
        * `TC` - Tc
        * `TV` - Tv
        * `UG` - Ug
        * `UA` - Ua
        * `AE` - Ae
        * `GB` - Gb
        * `US` - Us
        * `UM` - Um
        * `UY` - Uy
        * `UZ` - Uz
        * `VU` - Vu
        * `VE` - Ve
        * `VN` - Vn
        * `VG` - Vg
        * `VI` - Vi
        * `WF` - Wf
        * `EH` - Eh
        * `YE` - Ye
        * `ZM` - Zm
        * `ZW` - Zw
        * `AX` - Ax
  securitySchemes:
    ExternalAuthentication:
      type: apiKey
      in: header
      name: X-API-KEY

````