v50

latestOpenAPI 3.0.1Apache 2.0raw.githubusercontent.com2026-05-071740139.1 KB

NumbersV1SenderIdRegistration

Create Sender ID Registration

Creates a new sender ID registration and initializes an embedded Persona inquiry session. Returns registration details and embedded session credentials for rendering the Compliance Embeddable UI.

post/v1/SenderIdRegistrations

Request body

regulationIdstring required

The regulation for this registration.

regulationVersioninteger required

The regulation version.

friendlyNamestring required

Human-readable name for the registration.

statusNotificationEmailstring email

Email address for registration status notifications.

statusCallbackUrlstring uri nullable

The URL of this resource.

commentsstring

Additional comments about the registration.

themeSetIdstring

Theme ID for the Compliance Embeddable UI.

dataobject required

Registration data organized by section (alphanumericSender, business, useCase, authorizedRepresentative, officer, businessAddress).

Response

Created

idstring required

Registration identifier (BU-prefixed).

regulationIdstring required

The regulation ID for this registration.

regulationVersioninteger required

The regulation version.

friendlyNamestring required

The friendly name provided in the request.

statusstring required

Registration status. Always DRAFT on creation.

statusNotificationEmailstring email nullable

Email address for status notifications.

statusCallbackUrlstring nullable

Callback URL for status webhooks.

commentsstring nullable

Additional comments.

dataobject required

Registration data echoed from the request.

dateCreatedstring date-time required

Timestamp of creation.

dateUpdatedstring date-time required

Timestamp of last update.