> ## Documentation Index
> Fetch the complete documentation index at: https://openphone-dev.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# Create the A2P registration

> Create the organization's A2P (10DLC) draft registration. Organizations have at most one registration, so this returns 409 if one already exists.



## OpenAPI

````yaml https://openphone-public-api-dev.s3.us-west-2.amazonaws.com/public/openphone-public-api-2026-03-30-dev.json post /a2p-registration
openapi: 3.1.0
info:
  title: Quo Public API
  version: 1.0.0
  description: API for connecting with Quo.
  contact:
    name: Quo Support
    email: support@quo.com
    url: https://support.quo.com/
  termsOfService: https://www.quo.com/terms
servers:
  - description: Development server
    url: https://dev-public-api.openphone.dev
security:
  - apiKey: []
tags:
  - description: Operations related to the organization's A2P registration
    name: A2P Registration
  - description: Operations related to calls placed by an AI agent
    name: Agent Calls
  - description: Operations related to text conversations held by an AI agent
    name: Agent Conversations
  - description: Operations related to calls
    name: Calls
  - description: >-
      Operations related to call summaries, including AI-generated summaries and
      Sona voice assistant summaries
    name: Call Summaries
  - description: >-
      Operations related to call transcripts, including AI-generated transcripts
      and Sona voice assistant transcripts
    name: Call Transcripts
  - description: Operations related to contacts
    name: Contacts
  - description: Operations related to contact shares
    name: Contact Shares
  - description: Operations related to contact notes
    name: Contact Notes
  - description: Operations related to contact properties
    name: Contact Properties
  - description: Operations related to conversations
    name: Conversations
  - description: Operations related to workspace invitations
    name: Invites
  - description: Operations related to text messages
    name: Messages
  - description: Operations related to the organization
    name: Organization
  - description: Operations related to phone numbers
    name: Phone Numbers
  - description: Operations related to users
    name: Users
  - description: Operations related to webhooks
    name: Webhooks
  - description: >-
      Operations related to webhook events, including delivery history and test
      events
    name: Webhook Events
paths:
  /a2p-registration:
    post:
      tags:
        - A2P Registration
      summary: Create the A2P registration
      description: >-
        Create the organization's A2P (10DLC) draft registration. Organizations
        have at most one registration, so this returns 409 if one already
        exists.
      operationId: createA2PRegistration
      parameters:
        - in: header
          name: Quo-Api-Version
          required: true
          schema:
            type: string
            enum:
              - '2026-03-30'
            description: 'API version header. Supported values: 2026-03-30'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
                - name
                - alternateName
                - businessType
                - companyType
                - industry
                - employeeCount
                - avgDailyCallVolume
                - regionsOfOperation
                - websiteUrl
                - idType
                - idNumber
                - ticker
                - exchange
                - address
                - personOfContact
              properties:
                name:
                  type: string
                  minLength: 1
                  maxLength: 255
                  description: The legal or registered name of the business.
                  examples:
                    - Acme Inc
                  example: Acme Inc
                alternateName:
                  anyOf:
                    - type: string
                      minLength: 1
                      maxLength: 255
                      description: An alternate or doing-business-as name for the business.
                      examples:
                        - Acme
                      example: Acme
                    - type: 'null'
                businessType:
                  anyOf:
                    - type: string
                      const: Sole Proprietorship
                    - type: string
                      const: Partnership
                    - type: string
                      const: Corporation
                    - type: string
                      const: Co-operative
                    - type: string
                      const: Limited Liability Corporation
                    - type: string
                      const: Non-profit Corporation
                  description: >-
                    The legal structure of the business: one of `Sole
                    Proprietorship`, `Partnership`, `Corporation`,
                    `Co-operative`, `Limited Liability Corporation`, `Non-profit
                    Corporation`.
                  examples:
                    - Limited Liability Corporation
                  example: Limited Liability Corporation
                companyType:
                  anyOf:
                    - type: string
                      const: Private
                    - type: string
                      const: Public
                    - type: string
                      const: Non-profit
                    - type: string
                      const: Government
                  description: >-
                    The type of company. `ticker` and `exchange` are required
                    when this is `Public`.
                  examples:
                    - Private
                  example: Private
                industry:
                  anyOf:
                    - type: string
                      const: Agriculture
                    - type: string
                      const: Automotive
                    - type: string
                      const: Banking
                    - type: string
                      const: Consumer
                    - type: string
                      const: Education
                    - type: string
                      const: Electronics
                    - type: string
                      const: Energy
                    - type: string
                      const: Engineering
                    - type: string
                      const: Fast moving consumer goods
                    - type: string
                      const: Financial
                    - type: string
                      const: Fintech
                    - type: string
                      const: Food and beverage
                    - type: string
                      const: Government
                    - type: string
                      const: Healthcare
                    - type: string
                      const: Hospitality
                    - type: string
                      const: Insurance
                    - type: string
                      const: Jewelry
                    - type: string
                      const: Legal
                    - type: string
                      const: Manufacturing
                    - type: string
                      const: Media
                    - type: string
                      const: Not for profit
                    - type: string
                      const: Oil and gas
                    - type: string
                      const: Online
                    - type: string
                      const: Raw materials
                    - type: string
                      const: Real estate
                    - type: string
                      const: Religion
                    - type: string
                      const: Retail
                    - type: string
                      const: Technology
                    - type: string
                      const: Telecommunications
                    - type: string
                      const: Transportation
                    - type: string
                      const: Travel
                  description: >-
                    The industry the business operates in: one of `Agriculture`,
                    `Automotive`, `Banking`, `Consumer`, `Education`,
                    `Electronics`, `Energy`, `Engineering`, `Fast moving
                    consumer goods`, `Financial`, `Fintech`, `Food and
                    beverage`, `Government`, `Healthcare`, `Hospitality`,
                    `Insurance`, `Jewelry`, `Legal`, `Manufacturing`, `Media`,
                    `Not for profit`, `Oil and gas`, `Online`, `Raw materials`,
                    `Real estate`, `Religion`, `Retail`, `Technology`,
                    `Telecommunications`, `Transportation`, `Travel`.
                  examples:
                    - Technology
                  example: Technology
                employeeCount:
                  type: integer
                  minimum: 1
                  description: The number of employees at the business.
                  examples:
                    - 25
                  example: 25
                avgDailyCallVolume:
                  type: integer
                  minimum: 1
                  description: The business's average daily call volume.
                  examples:
                    - 100
                  example: 100
                regionsOfOperation:
                  type: array
                  items:
                    anyOf:
                      - type: string
                        const: Africa
                      - type: string
                        const: Asia
                      - type: string
                        const: Europe
                      - type: string
                        const: Latin America
                      - type: string
                        const: USA and Canada
                  minItems: 1
                  maxItems: 5
                  uniqueItems: true
                  description: >-
                    The regions the business operates in. Each entry is one of
                    `Africa`, `Asia`, `Europe`, `Latin America`, `USA and
                    Canada`.
                  examples:
                    - - USA and Canada
                  example:
                    - USA and Canada
                websiteUrl:
                  type: string
                  minLength: 1
                  maxLength: 255
                  format: uri
                  description: The business's website URL.
                  examples:
                    - https://acme.example
                  example: https://acme.example
                idType:
                  anyOf:
                    - type: string
                      const: 'USA: Employer Identification Number (EIN)'
                    - type: string
                      const: 'Canada: Canadian Business Number (BN-9)'
                    - type: string
                      const: 'Great Britain: Company Number'
                    - type: string
                      const: 'Australia: Company Number from ASIC (ACN)'
                    - type: string
                      const: 'India: Corporate Identity Number'
                    - type: string
                      const: 'Estonia: VAT Number'
                    - type: string
                      const: 'Romania: VAT Registration Number'
                    - type: string
                      const: 'Israel: Registration Number'
                    - type: string
                      const: Other
                  description: >-
                    The type of the business's government-issued tax ID: one of
                    `USA: Employer Identification Number (EIN)`, `Canada:
                    Canadian Business Number (BN-9)`, `Great Britain: Company
                    Number`, `Australia: Company Number from ASIC (ACN)`,
                    `India: Corporate Identity Number`, `Estonia: VAT Number`,
                    `Romania: VAT Registration Number`, `Israel: Registration
                    Number`, `Other`.
                  examples:
                    - 'USA: Employer Identification Number (EIN)'
                  example: 'USA: Employer Identification Number (EIN)'
                idNumber:
                  type: string
                  minLength: 1
                  maxLength: 255
                  description: >-
                    The business's government-issued tax ID number. An EIN must
                    carry exactly nine digits, and separators such as the dash
                    in `12-3456789` are ignored. A Canadian BN-9 must be exactly
                    nine digits with no separators.
                  examples:
                    - 12-3456789
                  example: 12-3456789
                ticker:
                  anyOf:
                    - type: string
                      minLength: 1
                      maxLength: 255
                      description: >-
                        The business's stock ticker symbol. Required when
                        `companyType` is `Public`.
                      examples:
                        - ACME
                      example: ACME
                    - type: 'null'
                exchange:
                  anyOf:
                    - anyOf:
                        - type: string
                          const: NASDAQ
                        - type: string
                          const: NYSE
                        - type: string
                          const: AMEX
                        - type: string
                          const: AMX
                        - type: string
                          const: ASX
                        - type: string
                          const: B3
                        - type: string
                          const: BME
                        - type: string
                          const: BSE
                        - type: string
                          const: FRA
                        - type: string
                          const: ICEX
                        - type: string
                          const: JPX
                        - type: string
                          const: JSE
                        - type: string
                          const: KRX
                        - type: string
                          const: LON
                        - type: string
                          const: NSE
                        - type: string
                          const: OMX
                        - type: string
                          const: SEHK
                        - type: string
                          const: SGX
                        - type: string
                          const: SSE
                        - type: string
                          const: STO
                        - type: string
                          const: SWX
                        - type: string
                          const: SZSE
                        - type: string
                          const: TSX
                        - type: string
                          const: TWSE
                        - type: string
                          const: VSE
                        - type: string
                          const: Other
                      description: >-
                        The stock exchange the business's ticker is listed on.
                        Required when `companyType` is `Public`. One of
                        `NASDAQ`, `NYSE`, `AMEX`, `AMX`, `ASX`, `B3`, `BME`,
                        `BSE`, `FRA`, `ICEX`, `JPX`, `JSE`, `KRX`, `LON`, `NSE`,
                        `OMX`, `SEHK`, `SGX`, `SSE`, `STO`, `SWX`, `SZSE`,
                        `TSX`, `TWSE`, `VSE`, `Other`.
                      examples:
                        - NASDAQ
                      example: NASDAQ
                    - type: 'null'
                address:
                  type: object
                  required:
                    - line1
                    - line2
                    - city
                    - region
                    - postalCode
                    - country
                  properties:
                    line1:
                      type: string
                      minLength: 1
                      maxLength: 255
                      description: The first line of the business's registered address.
                      examples:
                        - 1 Main St
                      example: 1 Main St
                    line2:
                      anyOf:
                        - type: string
                          minLength: 1
                          maxLength: 255
                          description: >-
                            The second line of the business's registered
                            address.
                          examples:
                            - Suite 200
                          example: Suite 200
                        - type: 'null'
                    city:
                      type: string
                      minLength: 1
                      maxLength: 255
                      description: The city of the business's registered address.
                      examples:
                        - San Francisco
                      example: San Francisco
                    region:
                      type: string
                      minLength: 1
                      maxLength: 255
                      description: >-
                        The state or region of the business's registered
                        address.
                      examples:
                        - CA
                      example: CA
                    postalCode:
                      type: string
                      minLength: 1
                      maxLength: 255
                      description: The postal code of the business's registered address.
                      examples:
                        - '94110'
                      example: '94110'
                    country:
                      type: string
                      minLength: 1
                      maxLength: 255
                      description: The country of the business's registered address.
                      examples:
                        - US
                      example: US
                personOfContact:
                  type: object
                  required:
                    - firstName
                    - lastName
                    - jobTitle
                    - jobPosition
                    - email
                    - phoneNumber
                  properties:
                    firstName:
                      type: string
                      minLength: 1
                      maxLength: 255
                      description: >-
                        The first name of the business contact submitting this
                        registration.
                      examples:
                        - Ada
                      example: Ada
                    lastName:
                      type: string
                      minLength: 1
                      maxLength: 255
                      description: >-
                        The last name of the business contact submitting this
                        registration.
                      examples:
                        - Lovelace
                      example: Lovelace
                    jobTitle:
                      type: string
                      minLength: 1
                      maxLength: 255
                      description: >-
                        The job title of the business contact submitting this
                        registration.
                      examples:
                        - CTO
                      example: CTO
                    jobPosition:
                      anyOf:
                        - type: string
                          const: Other
                        - type: string
                          const: Director
                        - type: string
                          const: GM
                        - type: string
                          const: VP
                        - type: string
                          const: CEO
                        - type: string
                          const: CFO
                        - type: string
                          const: General Counsel
                      description: >-
                        The job position of the business contact submitting this
                        registration: one of `Other`, `Director`, `GM`, `VP`,
                        `CEO`, `CFO`, `General Counsel`.
                      examples:
                        - Director
                      example: Director
                    email:
                      type: string
                      minLength: 1
                      maxLength: 255
                      format: email
                      description: The business contact's email address.
                      examples:
                        - ada@acme.example
                      example: ada@acme.example
                    phoneNumber:
                      type: string
                      maxLength: 255
                      pattern: ^\+[1-9]\d{1,14}$
                      description: The business contact's phone number, in E.164 format.
                      examples:
                        - '+15551234567'
                      example: '+15551234567'
      responses:
        '201':
          description: Created
          content:
            application/json:
              schema:
                type: object
                required:
                  - data
                properties:
                  data:
                    type: object
                    required:
                      - id
                      - draft
                      - status
                      - statusMessages
                      - type
                      - assignedPnId
                      - firstSubmittedAt
                      - createdAt
                      - updatedAt
                      - businessInfo
                      - messaging
                    properties:
                      id:
                        description: The unique identifier of the A2P registration.
                        examples:
                          - RG123abc
                        example: RG123abc
                        type: string
                        pattern: ^RG(.*)$
                      draft:
                        type: boolean
                        description: >-
                          True if the registration has not yet been submitted
                          for carrier approval. Combine with `status` to tell
                          submission states apart: `draft: true, status:
                          "pending"` means not yet submitted; `draft: false,
                          status: "pending"` means submitted and awaiting
                          carrier approval.
                      status:
                        anyOf:
                          - type: string
                            const: pending
                          - type: string
                            const: approved
                          - type: string
                            const: rejected
                          - type: string
                            const: failed
                        description: >-
                          The registration's overall status. `pending` is set
                          both at creation and while awaiting carrier approval
                          after submission — check `draft` to tell those two
                          apart. `rejected` and `failed` both mean the
                          registration must be resubmitted, which re-triggers
                          billing.
                        examples:
                          - pending
                        example: pending
                      statusMessages:
                        type: array
                        items:
                          type: object
                          required:
                            - errorCode
                            - errorReason
                          properties:
                            errorCode:
                              type: number
                              description: >-
                                The carrier error code associated with this
                                status message.
                            errorReason:
                              type: string
                              description: A human-readable explanation of the status.
                            fieldName:
                              type: string
                              description: >-
                                The single business-profile field this message
                                refers to, if any.
                            fields:
                              type: array
                              items:
                                type: string
                              description: >-
                                The business-profile fields this message refers
                                to, if any.
                        description: >-
                          Carrier-reported reasons for the current status, most
                          relevant when `status` is `rejected` or `failed`.
                      type:
                        anyOf:
                          - anyOf:
                              - type: string
                                const: standard
                              - type: string
                                const: lv-standard
                              - type: string
                                const: starter
                              - type: string
                                const: sole-prop
                            description: The type of A2P registration.
                            examples:
                              - standard
                            example: standard
                          - type: 'null'
                      assignedPnId:
                        anyOf:
                          - type: string
                            pattern: ^PN(.*)$
                          - type: 'null'
                      firstSubmittedAt:
                        anyOf:
                          - description: >-
                              The timestamp the registration was first submitted
                              for carrier approval.
                            type: string
                            format: date-time
                          - type: 'null'
                      createdAt:
                        description: The timestamp the registration was created.
                        type: string
                        format: date-time
                      updatedAt:
                        description: The timestamp the registration was last updated.
                        type: string
                        format: date-time
                      businessInfo:
                        type: object
                        required:
                          - name
                          - alternateName
                          - businessType
                          - companyType
                          - industry
                          - employeeCount
                          - avgDailyCallVolume
                          - regionsOfOperation
                          - websiteUrl
                          - useOpHostedPrivacyPolicy
                          - idType
                          - idNumber
                          - ticker
                          - exchange
                          - address
                          - personOfContact
                        properties:
                          name:
                            anyOf:
                              - type: string
                                description: The legal or registered name of the business.
                                examples:
                                  - Acme Inc
                                example: Acme Inc
                              - type: 'null'
                          alternateName:
                            anyOf:
                              - type: string
                                description: >-
                                  An alternate or doing-business-as name for the
                                  business.
                              - type: 'null'
                          businessType:
                            anyOf:
                              - type: string
                                description: The legal structure of the business.
                                examples:
                                  - Limited Liability Corporation
                                example: Limited Liability Corporation
                              - type: 'null'
                          companyType:
                            anyOf:
                              - anyOf:
                                  - type: string
                                    const: Private
                                  - type: string
                                    const: Public
                                  - type: string
                                    const: Non-profit
                                  - type: string
                                    const: Government
                                description: >-
                                  The type of company: one of `Private`,
                                  `Public`, `Non-profit`, `Government`.
                                examples:
                                  - Private
                                example: Private
                              - type: 'null'
                          industry:
                            anyOf:
                              - type: string
                                description: The industry the business operates in.
                              - type: 'null'
                          employeeCount:
                            anyOf:
                              - type: number
                                description: The number of employees at the business.
                              - type: 'null'
                          avgDailyCallVolume:
                            anyOf:
                              - type: number
                                description: The business's average daily call volume.
                              - type: 'null'
                          regionsOfOperation:
                            type: array
                            items:
                              anyOf:
                                - type: string
                                  const: Africa
                                - type: string
                                  const: Asia
                                - type: string
                                  const: Europe
                                - type: string
                                  const: Latin America
                                - type: string
                                  const: USA and Canada
                            description: >-
                              The regions the business operates in. Each entry
                              is one of `Africa`, `Asia`, `Europe`, `Latin
                              America`, `USA and Canada`.
                          websiteUrl:
                            anyOf:
                              - type: string
                                description: The business's website URL.
                                format: uri
                              - type: 'null'
                          useOpHostedPrivacyPolicy:
                            anyOf:
                              - type: boolean
                                description: >-
                                  Whether the business is using Quo's hosted
                                  privacy policy in place of its own.
                              - type: 'null'
                          idType:
                            anyOf:
                              - anyOf:
                                  - type: string
                                    const: 'Australia: Company Number from ASIC (ACN)'
                                  - type: string
                                    const: 'Canada: Business Number (BIN)'
                                  - type: string
                                    const: 'Canada: Canadian Business Number (BN-9)'
                                  - type: string
                                    const: 'Canada: Canadian Corporation Number (CCN)'
                                  - type: string
                                    const: 'Estonia: VAT Number'
                                  - type: string
                                    const: 'Great Britain: Company Number'
                                  - type: string
                                    const: 'India: Corporate Identity Number'
                                  - type: string
                                    const: 'Israel: Registration Number'
                                  - type: string
                                    const: 'Romania: VAT Registration Number'
                                  - type: string
                                    const: 'USA: DUNS Number (Dun & Bradstreet)'
                                  - type: string
                                    const: 'USA: Employer Identification Number (EIN)'
                                  - type: string
                                    const: Other
                                description: >-
                                  The type of the business's government-issued
                                  tax ID: one of `Australia: Company Number from
                                  ASIC (ACN)`, `Canada: Business Number (BIN)`,
                                  `Canada: Canadian Business Number (BN-9)`,
                                  `Canada: Canadian Corporation Number (CCN)`,
                                  `Estonia: VAT Number`, `Great Britain: Company
                                  Number`, `India: Corporate Identity Number`,
                                  `Israel: Registration Number`, `Romania: VAT
                                  Registration Number`, `USA: DUNS Number (Dun &
                                  Bradstreet)`, `USA: Employer Identification
                                  Number (EIN)`, `Other`.
                                examples:
                                  - 'USA: Employer Identification Number (EIN)'
                                example: 'USA: Employer Identification Number (EIN)'
                              - type: 'null'
                          idNumber:
                            anyOf:
                              - type: string
                                description: >-
                                  The business's government-issued tax ID
                                  number.
                              - type: 'null'
                          ticker:
                            anyOf:
                              - type: string
                                description: >-
                                  The business's stock ticker symbol, if
                                  publicly traded.
                              - type: 'null'
                          exchange:
                            anyOf:
                              - type: string
                                description: >-
                                  The stock exchange the business's ticker is
                                  listed on, if publicly traded.
                              - type: 'null'
                          address:
                            type: object
                            required:
                              - line1
                              - line2
                              - city
                              - region
                              - postalCode
                              - country
                            properties:
                              line1:
                                anyOf:
                                  - type: string
                                    description: >-
                                      The first line of the business's
                                      registered address.
                                  - type: 'null'
                              line2:
                                anyOf:
                                  - type: string
                                    description: >-
                                      The second line of the business's
                                      registered address.
                                  - type: 'null'
                              city:
                                anyOf:
                                  - type: string
                                    description: >-
                                      The city of the business's registered
                                      address.
                                  - type: 'null'
                              region:
                                anyOf:
                                  - type: string
                                    description: >-
                                      The state or region of the business's
                                      registered address.
                                  - type: 'null'
                              postalCode:
                                anyOf:
                                  - type: string
                                    description: >-
                                      The postal code of the business's
                                      registered address.
                                  - type: 'null'
                              country:
                                anyOf:
                                  - type: string
                                    description: >-
                                      The country of the business's registered
                                      address.
                                    examples:
                                      - US
                                    example: US
                                  - type: 'null'
                          personOfContact:
                            type: object
                            required:
                              - firstName
                              - lastName
                              - jobTitle
                              - jobPosition
                              - email
                              - phoneNumber
                            properties:
                              firstName:
                                anyOf:
                                  - type: string
                                    description: >-
                                      The first name of the business contact
                                      submitting this registration.
                                  - type: 'null'
                              lastName:
                                anyOf:
                                  - type: string
                                    description: >-
                                      The last name of the business contact
                                      submitting this registration.
                                  - type: 'null'
                              jobTitle:
                                anyOf:
                                  - type: string
                                    description: >-
                                      The job title of the business contact
                                      submitting this registration.
                                  - type: 'null'
                              jobPosition:
                                anyOf:
                                  - type: string
                                    description: >-
                                      The job position of the business contact
                                      submitting this registration.
                                  - type: 'null'
                              email:
                                anyOf:
                                  - type: string
                                    description: The business contact's email address.
                                    format: email
                                  - type: 'null'
                              phoneNumber:
                                anyOf:
                                  - type: string
                                    description: The business contact's phone number.
                                  - type: 'null'
                      messaging:
                        type: object
                        required:
                          - useCase
                          - description
                          - samples
                          - flow
                          - personalUse
                          - consent
                        properties:
                          useCase:
                            anyOf:
                              - type: string
                                description: >-
                                  The messaging use case this registration was
                                  created for.
                              - type: 'null'
                          description:
                            anyOf:
                              - type: string
                                description: >-
                                  A description of the messages the business
                                  sends.
                              - type: 'null'
                          samples:
                            type: array
                            items:
                              type: string
                            description: Sample messages submitted for carrier vetting.
                          flow:
                            anyOf:
                              - type: string
                                description: >-
                                  A description of how end users opt in to
                                  receive messages from the business.
                              - type: 'null'
                          personalUse:
                            anyOf:
                              - type: boolean
                                description: >-
                                  Whether this registration is for an individual
                                  sending messages personally.
                              - type: 'null'
                          consent:
                            anyOf:
                              - type: object
                                properties:
                                  digitalForm:
                                    type: object
                                    required:
                                      - enabled
                                    properties:
                                      enabled:
                                        type: boolean
                                        description: Whether this consent channel is in use.
                                      askForConsentExample:
                                        type: string
                                        description: >-
                                          An example of how consent is requested
                                          through this channel.
                                      screenshotUrl:
                                        type: string
                                        description: >-
                                          A screenshot demonstrating this consent
                                          channel.
                                      storeUrl:
                                        type: string
                                        description: >-
                                          The app store URL for this consent
                                          channel.
                                      text:
                                        type: string
                                        description: >-
                                          The consent text shown to the end user
                                          through this channel.
                                      url:
                                        type: string
                                        description: >-
                                          A URL demonstrating or hosting this
                                          consent channel.
                                  mobileApp:
                                    type: object
                                    required:
                                      - enabled
                                    properties:
                                      enabled:
                                        type: boolean
                                        description: Whether this consent channel is in use.
                                      askForConsentExample:
                                        type: string
                                        description: >-
                                          An example of how consent is requested
                                          through this channel.
                                      screenshotUrl:
                                        type: string
                                        description: >-
                                          A screenshot demonstrating this consent
                                          channel.
                                      storeUrl:
                                        type: string
                                        description: >-
                                          The app store URL for this consent
                                          channel.
                                      text:
                                        type: string
                                        description: >-
                                          The consent text shown to the end user
                                          through this channel.
                                      url:
                                        type: string
                                        description: >-
                                          A URL demonstrating or hosting this
                                          consent channel.
                                  onSite:
                                    type: object
                                    required:
                                      - enabled
                                    properties:
                                      enabled:
                                        type: boolean
                                        description: Whether this consent channel is in use.
                                      askForConsentExample:
                                        type: string
                                        description: >-
                                          An example of how consent is requested
                                          through this channel.
                                      screenshotUrl:
                                        type: string
                                        description: >-
                                          A screenshot demonstrating this consent
                                          channel.
                                      storeUrl:
                                        type: string
                                        description: >-
                                          The app store URL for this consent
                                          channel.
                                      text:
                                        type: string
                                        description: >-
                                          The consent text shown to the end user
                                          through this channel.
                                      url:
                                        type: string
                                        description: >-
                                          A URL demonstrating or hosting this
                                          consent channel.
                                  other:
                                    type: object
                                    required:
                                      - enabled
                                    properties:
                                      enabled:
                                        type: boolean
                                        description: Whether this consent channel is in use.
                                      askForConsentExample:
                                        type: string
                                        description: >-
                                          An example of how consent is requested
                                          through this channel.
                                      screenshotUrl:
                                        type: string
                                        description: >-
                                          A screenshot demonstrating this consent
                                          channel.
                                      storeUrl:
                                        type: string
                                        description: >-
                                          The app store URL for this consent
                                          channel.
                                      text:
                                        type: string
                                        description: >-
                                          The consent text shown to the end user
                                          through this channel.
                                      url:
                                        type: string
                                        description: >-
                                          A URL demonstrating or hosting this
                                          consent channel.
                                  physicalForm:
                                    type: object
                                    required:
                                      - enabled
                                    properties:
                                      enabled:
                                        type: boolean
                                        description: Whether this consent channel is in use.
                                      askForConsentExample:
                                        type: string
                                        description: >-
                                          An example of how consent is requested
                                          through this channel.
                                      screenshotUrl:
                                        type: string
                                        description: >-
                                          A screenshot demonstrating this consent
                                          channel.
                                      storeUrl:
                                        type: string
                                        description: >-
                                          The app store URL for this consent
                                          channel.
                                      text:
                                        type: string
                                        description: >-
                                          The consent text shown to the end user
                                          through this channel.
                                      url:
                                        type: string
                                        description: >-
                                          A URL demonstrating or hosting this
                                          consent channel.
                                  textMessage:
                                    type: object
                                    required:
                                      - enabled
                                    properties:
                                      enabled:
                                        type: boolean
                                        description: Whether this consent channel is in use.
                                      askForConsentExample:
                                        type: string
                                        description: >-
                                          An example of how consent is requested
                                          through this channel.
                                      screenshotUrl:
                                        type: string
                                        description: >-
                                          A screenshot demonstrating this consent
                                          channel.
                                      storeUrl:
                                        type: string
                                        description: >-
                                          The app store URL for this consent
                                          channel.
                                      text:
                                        type: string
                                        description: >-
                                          The consent text shown to the end user
                                          through this channel.
                                      url:
                                        type: string
                                        description: >-
                                          A URL demonstrating or hosting this
                                          consent channel.
                                  verbal:
                                    type: object
                                    required:
                                      - enabled
                                    properties:
                                      enabled:
                                        type: boolean
                                        description: Whether this consent channel is in use.
                                      askForConsentExample:
                                        type: string
                                        description: >-
                                          An example of how consent is requested
                                          through this channel.
                                      screenshotUrl:
                                        type: string
                                        description: >-
                                          A screenshot demonstrating this consent
                                          channel.
                                      storeUrl:
                                        type: string
                                        description: >-
                                          The app store URL for this consent
                                          channel.
                                      text:
                                        type: string
                                        description: >-
                                          The consent text shown to the end user
                                          through this channel.
                                      url:
                                        type: string
                                        description: >-
                                          A URL demonstrating or hosting this
                                          consent channel.
                                  websiteForm:
                                    type: object
                                    required:
                                      - enabled
                                    properties:
                                      enabled:
                                        type: boolean
                                        description: Whether this consent channel is in use.
                                      askForConsentExample:
                                        type: string
                                        description: >-
                                          An example of how consent is requested
                                          through this channel.
                                      screenshotUrl:
                                        type: string
                                        description: >-
                                          A screenshot demonstrating this consent
                                          channel.
                                      storeUrl:
                                        type: string
                                        description: >-
                                          The app store URL for this consent
                                          channel.
                                      text:
                                        type: string
                                        description: >-
                                          The consent text shown to the end user
                                          through this channel.
                                      url:
                                        type: string
                                        description: >-
                                          A URL demonstrating or hosting this
                                          consent channel.
                                  written:
                                    type: object
                                    required:
                                      - enabled
                                    properties:
                                      enabled:
                                        type: boolean
                                        description: Whether this consent channel is in use.
                                      askForConsentExample:
                                        type: string
                                        description: >-
                                          An example of how consent is requested
                                          through this channel.
                                      screenshotUrl:
                                        type: string
                                        description: >-
                                          A screenshot demonstrating this consent
                                          channel.
                                      storeUrl:
                                        type: string
                                        description: >-
                                          The app store URL for this consent
                                          channel.
                                      text:
                                        type: string
                                        description: >-
                                          The consent text shown to the end user
                                          through this channel.
                                      url:
                                        type: string
                                        description: >-
                                          A URL demonstrating or hosting this
                                          consent channel.
                              - type: 'null'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                type: object
                required:
                  - message
                  - docs
                  - title
                properties:
                  message:
                    type: string
                  docs:
                    type: string
                    const: https://quo.com/docs
                  title:
                    type: string
                    const: Bad Request
                  trace:
                    type: string
                  errors:
                    type: array
                    items:
                      type: object
                      required:
                        - path
                        - message
                        - schema
                      properties:
                        path:
                          type: string
                        message:
                          type: string
                        value: {}
                        schema:
                          type: object
                          required:
                            - type
                          properties:
                            type:
                              type: string
              example:
                message: The input was invalid
                docs: https://quo.com/docs
                title: Bad Request
                trace: '6897907457496870895'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                type: object
                required:
                  - message
                  - docs
                  - title
                properties:
                  message:
                    type: string
                  docs:
                    type: string
                    const: https://quo.com/docs
                  title:
                    type: string
                    const: Unauthorized
                  trace:
                    type: string
                  errors:
                    type: array
                    items:
                      type: object
                      required:
                        - path
                        - message
                        - schema
                      properties:
                        path:
                          type: string
                        message:
                          type: string
                        value: {}
                        schema:
                          type: object
                          required:
                            - type
                          properties:
                            type:
                              type: string
              example:
                message: User is unauthorized to perform this action
                docs: https://quo.com/docs
                title: Unauthorized
                trace: '6897907457496870895'
        '402':
          description: Subscription Expired
          content:
            application/json:
              schema:
                type: object
                required:
                  - message
                  - docs
                  - title
                properties:
                  message:
                    type: string
                  docs:
                    type: string
                    const: https://quo.com/docs
                  title:
                    type: string
                    const: Subscription Expired
                  trace:
                    type: string
                  errors:
                    type: array
                    items:
                      type: object
                      required:
                        - path
                        - message
                        - schema
                      properties:
                        path:
                          type: string
                        message:
                          type: string
                        value: {}
                        schema:
                          type: object
                          required:
                            - type
                          properties:
                            type:
                              type: string
              example:
                message: This subscription is not able to register for A2P
                docs: https://quo.com/docs
                title: Subscription Expired
                trace: '6897907457496870895'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                type: object
                required:
                  - message
                  - docs
                  - title
                properties:
                  message:
                    type: string
                  docs:
                    type: string
                    const: https://quo.com/docs
                  title:
                    type: string
                    const: Forbidden
                  trace:
                    type: string
                  errors:
                    type: array
                    items:
                      type: object
                      required:
                        - path
                        - message
                        - schema
                      properties:
                        path:
                          type: string
                        message:
                          type: string
                        value: {}
                        schema:
                          type: object
                          required:
                            - type
                          properties:
                            type:
                              type: string
              example:
                message: User is forbidden to perform this action
                docs: https://quo.com/docs
                title: Forbidden
                trace: '6897907457496870895'
        '409':
          description: Conflict
          content:
            application/json:
              schema:
                type: object
                required:
                  - message
                  - docs
                  - title
                properties:
                  message:
                    type: string
                  docs:
                    type: string
                    const: https://quo.com/docs
                  title:
                    type: string
                    const: Conflict
                  trace:
                    type: string
                  errors:
                    type: array
                    items:
                      type: object
                      required:
                        - path
                        - message
                        - schema
                      properties:
                        path:
                          type: string
                        message:
                          type: string
                        value: {}
                        schema:
                          type: object
                          required:
                            - type
                          properties:
                            type:
                              type: string
              example:
                message: This organization already has an A2P registration
                docs: https://quo.com/docs
                title: Conflict
                trace: '6897907457496870895'
        '422':
          description: Unprocessable Entity
          content:
            application/json:
              schema:
                type: object
                required:
                  - message
                  - docs
                  - title
                properties:
                  message:
                    type: string
                  docs:
                    type: string
                    const: https://quo.com/docs
                  title:
                    type: string
                    const: Unprocessable Entity
                  trace:
                    type: string
                  errors:
                    type: array
                    items:
                      type: object
                      required:
                        - path
                        - message
                        - schema
                      properties:
                        path:
                          type: string
                        message:
                          type: string
                        value: {}
                        schema:
                          type: object
                          required:
                            - type
                          properties:
                            type:
                              type: string
              example:
                message: >-
                  idNumber must contain exactly nine digits for idType USA:
                  Employer Identification Number (EIN)
                docs: https://quo.com/docs
                title: Unprocessable Entity
                trace: '6897907457496870895'
        '500':
          description: Unknown Error
          content:
            application/json:
              schema:
                type: object
                required:
                  - message
                  - docs
                  - title
                properties:
                  message:
                    type: string
                  docs:
                    type: string
                    const: https://quo.com/docs
                  title:
                    type: string
                    const: Unknown
                  trace:
                    type: string
                  errors:
                    type: array
                    items:
                      type: object
                      required:
                        - path
                        - message
                        - schema
                      properties:
                        path:
                          type: string
                        message:
                          type: string
                        value: {}
                        schema:
                          type: object
                          required:
                            - type
                          properties:
                            type:
                              type: string
              example:
                message: An unknown error has occurred
                docs: https://quo.com/docs
                title: Unknown Error
                trace: '6897907457496870895'
      security:
        - apiKey: []
components:
  securitySchemes:
    apiKey:
      in: header
      name: Authorization
      type: apiKey

````