Sender IDs
Register a Sender ID
Submit a new Sender ID for registration on a market register.
POST
/
v1
/
sids
Register a Sender ID
curl --request POST \
--url https://api.example.com/v1/sids \
--header 'Content-Type: application/json' \
--data '
{
"sender_id": "<string>",
"brand_id": "<string>",
"market": "<string>",
"use_case": "<string>",
"match_type": "<string>",
"match_value": "<string>"
}
'import requests
url = "https://api.example.com/v1/sids"
payload = {
"sender_id": "<string>",
"brand_id": "<string>",
"market": "<string>",
"use_case": "<string>",
"match_type": "<string>",
"match_value": "<string>"
}
headers = {"Content-Type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({
sender_id: '<string>',
brand_id: '<string>',
market: '<string>',
use_case: '<string>',
match_type: '<string>',
match_value: '<string>'
})
};
fetch('https://api.example.com/v1/sids', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.example.com/v1/sids",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'sender_id' => '<string>',
'brand_id' => '<string>',
'market' => '<string>',
'use_case' => '<string>',
'match_type' => '<string>',
'match_value' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.example.com/v1/sids"
payload := strings.NewReader("{\n \"sender_id\": \"<string>\",\n \"brand_id\": \"<string>\",\n \"market\": \"<string>\",\n \"use_case\": \"<string>\",\n \"match_type\": \"<string>\",\n \"match_value\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.example.com/v1/sids")
.header("Content-Type", "application/json")
.body("{\n \"sender_id\": \"<string>\",\n \"brand_id\": \"<string>\",\n \"market\": \"<string>\",\n \"use_case\": \"<string>\",\n \"match_type\": \"<string>\",\n \"match_value\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/v1/sids")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n \"sender_id\": \"<string>\",\n \"brand_id\": \"<string>\",\n \"market\": \"<string>\",\n \"use_case\": \"<string>\",\n \"match_type\": \"<string>\",\n \"match_value\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"ok": true,
"data": {
"id": "sid_j1k2l3m4",
"sender_id": "TrackFast",
"brand_id": "brand_f6g7h8i9",
"market": "AU",
"status": "pending_review",
"match_type": "business_name",
"match_value": "TrackFast Logistics Pty Ltd",
"created_at": "2026-07-17T14:30:00+10:00"
},
"meta": {
"request_id": "req_yza567",
"timestamp": "2026-07-17T14:30:00+10:00"
}
}
Required permission:
sids:write
The owning brand must be in verified status before a SID can be registered.
Request body
string
required
The alphanumeric Sender ID. 2-11 characters. Cannot be numbers only.
string
required
Reference to a previously onboarded and verified brand entity.
string
required
ISO 3166-1 alpha-2 country code. Determines which register and validation rules apply.
string
required
Plain-text description of intended message content.
string
required
One of:
business_name, company_name, trademark, domain.string
required
The registered name, mark, or domain the SID matches against.
Example
curl -X POST https://api.senderz.ai/v1/sids \
-H "Authorization: Bearer sz_live_xxxxxxxxxxxxx" \
-H "Content-Type: application/json" \
-d '{
"sender_id": "TrackFast",
"brand_id": "brand_f6g7h8i9",
"market": "AU",
"use_case": "Dispatch and delivery notifications for e-commerce orders.",
"match_type": "business_name",
"match_value": "TrackFast Logistics Pty Ltd"
}'
Response
{
"ok": true,
"data": {
"id": "sid_j1k2l3m4",
"sender_id": "TrackFast",
"brand_id": "brand_f6g7h8i9",
"market": "AU",
"status": "pending_review",
"match_type": "business_name",
"match_value": "TrackFast Logistics Pty Ltd",
"created_at": "2026-07-17T14:30:00+10:00"
},
"meta": {
"request_id": "req_yza567",
"timestamp": "2026-07-17T14:30:00+10:00"
}
}
⌘I
Register a Sender ID
curl --request POST \
--url https://api.example.com/v1/sids \
--header 'Content-Type: application/json' \
--data '
{
"sender_id": "<string>",
"brand_id": "<string>",
"market": "<string>",
"use_case": "<string>",
"match_type": "<string>",
"match_value": "<string>"
}
'import requests
url = "https://api.example.com/v1/sids"
payload = {
"sender_id": "<string>",
"brand_id": "<string>",
"market": "<string>",
"use_case": "<string>",
"match_type": "<string>",
"match_value": "<string>"
}
headers = {"Content-Type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({
sender_id: '<string>',
brand_id: '<string>',
market: '<string>',
use_case: '<string>',
match_type: '<string>',
match_value: '<string>'
})
};
fetch('https://api.example.com/v1/sids', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.example.com/v1/sids",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'sender_id' => '<string>',
'brand_id' => '<string>',
'market' => '<string>',
'use_case' => '<string>',
'match_type' => '<string>',
'match_value' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.example.com/v1/sids"
payload := strings.NewReader("{\n \"sender_id\": \"<string>\",\n \"brand_id\": \"<string>\",\n \"market\": \"<string>\",\n \"use_case\": \"<string>\",\n \"match_type\": \"<string>\",\n \"match_value\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.example.com/v1/sids")
.header("Content-Type", "application/json")
.body("{\n \"sender_id\": \"<string>\",\n \"brand_id\": \"<string>\",\n \"market\": \"<string>\",\n \"use_case\": \"<string>\",\n \"match_type\": \"<string>\",\n \"match_value\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/v1/sids")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n \"sender_id\": \"<string>\",\n \"brand_id\": \"<string>\",\n \"market\": \"<string>\",\n \"use_case\": \"<string>\",\n \"match_type\": \"<string>\",\n \"match_value\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"ok": true,
"data": {
"id": "sid_j1k2l3m4",
"sender_id": "TrackFast",
"brand_id": "brand_f6g7h8i9",
"market": "AU",
"status": "pending_review",
"match_type": "business_name",
"match_value": "TrackFast Logistics Pty Ltd",
"created_at": "2026-07-17T14:30:00+10:00"
},
"meta": {
"request_id": "req_yza567",
"timestamp": "2026-07-17T14:30:00+10:00"
}
}
.jpg?fit=max&auto=format&n=IhWYk8R5R6sdJ_7C&q=85&s=7e3194d82fa9653ad2a2449b4f1a3073)