List available Sender IDs

GET

verification

management

sender-id

curl --request GET \
  --url https://api.prelude.dev/v2/verification/management/sender-id \
  --header 'Authorization: Bearer <token>'

{
  "sender_ids": [
    {
      "sender_id": "<string>"
    }
  ]
}

List the custom sender IDs registered on your account. Sender IDs are branded identifiers (such as your company name) that appear as the sender of verification messages. Use this endpoint to inspect the sender IDs Prelude has approved for you and to check their country availability before referencing one in the options.sender_id field of a Create Verification request.

Access to the management API is opt-in. Contact our support team to enable it on your account. For background on how sender IDs work, see the Custom Sender IDs guide.

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Response

A list of Sender ID.

sender_ids

object[]

Show child attributes

Submit a sender IDThis endpoint allows you to submit a new sender ID for verification purposes. In order to get access to this endpoint, contact our support team.

List available Sender IDs

curl --request GET \
  --url https://api.prelude.dev/v2/verification/management/sender-id \
  --header 'Authorization: Bearer <token>'

{
  "sender_ids": [
    {
      "sender_id": "<string>"
    }
  ]
}