Upsert Caller ID Name (CNAM) | Atlas

curl -X PUT https://api.youratlas.com/v1/api/business-verification/cnam \
     -H "api-key: <apiKey>" \
     -H "Content-Type: application/json" \
     -d '{
  "cnam_display_name": "string",
  "phoneNumbers": [
    "string"
  ]
}'

{
  "secondaryProfileSid": "string",
  "addressSid": "string",
  "addressDocumentSid": "string",
  "businessInfoEndUserSid": "string",
  "ar1EndUserSid": "string",
  "ar2EndUserSid": "string",
  "trustProductSid": "string",
  "secondaryProfileStatus": "draft",
  "trustProductStatus": "draft",
  "providerFailures": [
    {
      "code": "string",
      "message": "string"
    }
  ],
  "lastEvaluationErrors": null,
  "voiceIntegrityTrustProductSid": "string",
  "voiceIntegrityStatus": "draft",
  "voiceIntegrityFailures": [
    {
      "code": "string",
      "message": "string"
    }
  ],
  "voiceIntegrityData": {
    "use_case": "string",
    "business_employee_count": "string",
    "average_business_day_call_volume": "string",
    "notes": "string"
  },
  "cnamTrustProductSid": "string",
  "cnamStatus": "draft",
  "cnamPhoneNumbers": [
    "string"
  ],
  "cnamFailures": [
    {
      "code": "string",
      "message": "string"
    }
  ],
  "cnamData": {
    "cnam_display_name": "string",
    "phoneNumbers": [
      "string"
    ]
  },
  "formData": {
    "address": {
      "customerName": "string",
      "street": "string",
      "city": "string",
      "region": "string",
      "postalCode": "string",
      "isoCountry": "string"
    },
    "businessInformation": {
      "business_type": "string",
      "business_registration_number": "string",
      "business_name": "string",
      "business_registration_identifier": "string",
      "business_identity": "direct_customer",
      "business_industry": "string",
      "website_url": "string",
      "business_regions_of_operation": "string",
      "social_media_profile_urls": "string"
    },
    "authorizedRep1": {
      "first_name": "string",
      "last_name": "string",
      "email": "string",
      "phone_number": "string",
      "business_title": "string",
      "job_position": "string"
    },
    "authorizedRep2": {
      "first_name": "string",
      "last_name": "string",
      "email": "string",
      "phone_number": "string",
      "business_title": "string",
      "job_position": "string"
    },
    "email": "string",
    "friendlyName": "string"
  },
  "lastUpdated": "2024-01-15T09:30:00Z"
}

Saves CNAM (Caller ID Name) registration data for one or more phone numbers. Requires an approved Secondary Customer Profile. The CNAM display name is shared across all listed numbers. Returns 202 with the current profile snapshot including CNAM status.

Authentication

api-keystring

Your Atlas API key. Get it from the Atlas Portal under Settings > API Keys.

Request

This endpoint expects an object.

cnam_display_namestringRequired<=15 characters

Caller ID display name (max 15 characters). Must begin with a letter and contain only letters, numbers, spaces, periods, and commas.

phoneNumberslist of stringsRequired

US phone numbers in E.164 format (e.g. +14155551234). Toll-free numbers are not eligible for CNAM.

Response

Accepted — CNAM data saved, background processing started

secondaryProfileSidstringOptional

addressSidstringOptional

addressDocumentSidstringOptional

businessInfoEndUserSidstringOptional

ar1EndUserSidstringOptional

ar2EndUserSidstringOptional

trustProductSidstringOptional

secondaryProfileStatusenumOptional

Allowed values:

trustProductStatusenumOptional

Allowed values:

providerFailureslist of objects or nullOptional

Customer-actionable failures from the provider, or null

lastEvaluationErrorsany or nullOptional

Parsed evaluation errors from Twilio, or null (legacy)

voiceIntegrityTrustProductSidstringOptional

Twilio Trust Product SID for Voice Integrity add-on

voiceIntegrityStatusenumOptional

Current status of the Voice Integrity trust product

Allowed values:

voiceIntegrityFailureslist of objects or nullOptional

Voice Integrity provider failures, or null

voiceIntegrityDataobject or nullOptional

Persisted Voice Integrity form data for rehydrating the UI

cnamTrustProductSidstringOptional

Twilio Trust Product SID for CNAM add-on

cnamStatusenumOptional

Current status of the CNAM trust product

Allowed values:

cnamPhoneNumberslist of stringsOptional

Phone numbers sharing the CNAM display name (E.164 format)

cnamFailureslist of objects or nullOptional

CNAM provider failures, or null

cnamDataobject or nullOptional

Persisted CNAM form data for rehydrating the UI

formDataobjectOptional

Rehydrated form data from the original business info submission

lastUpdateddatetimeOptional

Errors

400

Bad Request Error

409

Conflict Error

500

Internal Server Error