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.

POST /a2p-registration

Create the A2P registration

cURL

curl --request POST \
  --url https://dev-public-api.openphone.dev/a2p-registration \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --header 'Quo-Api-Version: <quo-api-version>' \
  --data '
{
  "name": "Acme Inc",
  "alternateName": "Acme",
  "businessType": "Limited Liability Corporation",
  "companyType": "Private",
  "industry": "Technology",
  "employeeCount": 25,
  "avgDailyCallVolume": 100,
  "regionsOfOperation": [
    "USA and Canada"
  ],
  "websiteUrl": "https://acme.example",
  "idType": "USA: Employer Identification Number (EIN)",
  "idNumber": "12-3456789",
  "ticker": "ACME",
  "exchange": "NASDAQ",
  "address": {
    "line1": "1 Main St",
    "line2": "Suite 200",
    "city": "San Francisco",
    "region": "CA",
    "postalCode": "94110",
    "country": "US"
  },
  "personOfContact": {
    "firstName": "Ada",
    "lastName": "Lovelace",
    "jobTitle": "CTO",
    "jobPosition": "Director",
    "email": "[e-mail]",
    "phoneNumber": "[phone]"
  }
}
'

201

{
  "data": {
    "id": "RG123abc",
    "draft": true,
    "status": "pending",
    "statusMessages": [
      {
        "errorCode": 123,
        "errorReason": "<string>",
        "fieldName": "<string>",
        "fields": [
          "<string>"
        ]
      }
    ],
    "type": "standard",
    "assignedPnId": "<string>",
    "firstSubmittedAt": "2023-11-07T05:31:56Z",
    "createdAt": "2023-11-07T05:31:56Z",
    "updatedAt": "2023-11-07T05:31:56Z",
    "businessInfo": {
      "name": "Acme Inc",
      "alternateName": "<string>",
      "businessType": "Limited Liability Corporation",
      "companyType": "Private",
      "industry": "<string>",
      "employeeCount": 123,
      "avgDailyCallVolume": 123,
      "regionsOfOperation": [
        "Africa"
      ],
      "websiteUrl": "<string>",
      "useOpHostedPrivacyPolicy": true,
      "idType": "USA: Employer Identification Number (EIN)",
      "idNumber": "<string>",
      "ticker": "<string>",
      "exchange": "<string>",
      "address": {
        "line1": "<string>",
        "line2": "<string>",
        "city": "<string>",
        "region": "<string>",
        "postalCode": "<string>",
        "country": "US"
      },
      "personOfContact": {
        "firstName": "<string>",
        "lastName": "<string>",
        "jobTitle": "<string>",
        "jobPosition": "<string>",
        "email": "[e-mail]",
        "phoneNumber": "<string>"
      }
    },
    "messaging": {
      "useCase": "<string>",
      "description": "<string>",
      "samples": [
        "<string>"
      ],
      "flow": "<string>",
      "personalUse": true,
      "consent": {
        "digitalForm": {
          "enabled": true,
          "askForConsentExample": "<string>",
          "screenshotUrl": "<string>",
          "storeUrl": "<string>",
          "text": "<string>",
          "url": "<string>"
        },
        "mobileApp": {
          "enabled": true,
          "askForConsentExample": "<string>",
          "screenshotUrl": "<string>",
          "storeUrl": "<string>",
          "text": "<string>",
          "url": "<string>"
        },
        "onSite": {
          "enabled": true,
          "askForConsentExample": "<string>",
          "screenshotUrl": "<string>",
          "storeUrl": "<string>",
          "text": "<string>",
          "url": "<string>"
        },
        "other": {
          "enabled": true,
          "askForConsentExample": "<string>",
          "screenshotUrl": "<string>",
          "storeUrl": "<string>",
          "text": "<string>",
          "url": "<string>"
        },
        "physicalForm": {
          "enabled": true,
          "askForConsentExample": "<string>",
          "screenshotUrl": "<string>",
          "storeUrl": "<string>",
          "text": "<string>",
          "url": "<string>"
        },
        "textMessage": {
          "enabled": true,
          "askForConsentExample": "<string>",
          "screenshotUrl": "<string>",
          "storeUrl": "<string>",
          "text": "<string>",
          "url": "<string>"
        },
        "verbal": {
          "enabled": true,
          "askForConsentExample": "<string>",
          "screenshotUrl": "<string>",
          "storeUrl": "<string>",
          "text": "<string>",
          "url": "<string>"
        },
        "websiteForm": {
          "enabled": true,
          "askForConsentExample": "<string>",
          "screenshotUrl": "<string>",
          "storeUrl": "<string>",
          "text": "<string>",
          "url": "<string>"
        },
        "written": {
          "enabled": true,
          "askForConsentExample": "<string>",
          "screenshotUrl": "<string>",
          "storeUrl": "<string>",
          "text": "<string>",
          "url": "<string>"
        }
      }
    }
  }
}

Authorizations

Authorization · string · header · required

Headers

Quo-Api-Version · enum<string> · required

API version header. Supported values: 2026-03-30

Available options: 2026-03-30

Body

application/json

name · string · required

The legal or registered name of the business.

Required string length: 1 - 255

Example:

"Acme Inc"

alternateName · string | null · required

An alternate or doing-business-as name for the business.

Required string length: 1 - 255

Example:

"Acme"

businessType · Option 1 · string Option 2 · string Option 3 · string Option 4 · string Option 5 · string Option 6 · string · required

The legal structure of the business: one of Sole Proprietorship, Partnership, Corporation, Co-operative, Limited Liability Corporation, Non-profit Corporation.

Allowed value: "Sole Proprietorship"

Example:

"Limited Liability Corporation"

companyType · Option 1 · string Option 2 · string Option 3 · string Option 4 · string · required

The type of company. ticker and exchange are required when this is Public.

Allowed value: "Private"

Example:

"Private"

industry · Option 1 · string Option 2 · string Option 3 · string Option 4 · string Option 5 · string Option 6 · string Option 7 · string Option 8 · string Option 9 · string Option 10 · string Option 11 · string Option 12 · string Option 13 · string Option 14 · string Option 15 · string Option 16 · string Option 17 · string Option 18 · string Option 19 · string Option 20 · string Option 21 · string Option 22 · string Option 23 · string Option 24 · string Option 25 · string Option 26 · string Option 27 · string Option 28 · string Option 29 · string Option 30 · string Option 31 · string · required

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.

Allowed value: "Agriculture"

Example:

"Technology"

employeeCount · integer · required

The number of employees at the business.

Required range: x >= 1

Example:

25

avgDailyCallVolume · integer · required

The business's average daily call volume.

Required range: x >= 1

Example:

100

regionsOfOperation · string[] · required

The regions the business operates in. Each entry is one of Africa, Asia, Europe, Latin America, USA and Canada.

Required array length: 1 - 5 elements

Allowed value: "Africa"

Example:

["USA and Canada"]

websiteUrl · string<uri> · required

The business's website URL.

Required string length: 1 - 255

Example:

"https://acme.example"

idType · Option 1 · string Option 2 · string Option 3 · string Option 4 · string Option 5 · string Option 6 · string Option 7 · string Option 8 · string Option 9 · string · required

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.

Allowed value: "USA: Employer Identification Number (EIN)"

Example:

"USA: Employer Identification Number (EIN)"

idNumber · string · required

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.

Required string length: 1 - 255

Example:

"12-3456789"

ticker · string | null · required

The business's stock ticker symbol. Required when companyType is Public.

Required string length: 1 - 255

Example:

"ACME"

exchange · Option 1 · string Option 2 · string Option 3 · string Option 4 · string Option 5 · string Option 6 · string Option 7 · string Option 8 · string Option 9 · string Option 10 · string Option 11 · string Option 12 · string Option 13 · string Option 14 · string Option 15 · string Option 16 · string Option 17 · string Option 18 · string Option 19 · string Option 20 · string Option 21 · string Option 22 · string Option 23 · string Option 24 · string Option 25 · string Option 26 · string · required

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.

Allowed value: "NASDAQ"

Example:

"NASDAQ"

address · object · required

Show child attributes

personOfContact · object · required

Show child attributes

Response

201

application/json

Created

data · object · required

Show child attributes