This API describes the set of endpoints available to get each market requirements and create registration for sender IDs.
The list of endpoints allows to create, update and delete a registration and also get the current state. For each market, customers can check the different requirements depending on the new sender ID scope, and also download templates to fill in for the registrations.
Interested in this API? Please, reach out to your Account Manager for more info.
You can set up callback URLs to receive event notifications when your registration status is updated. When delivering events the order is not guaranteed (for example, a failed event scheduled for retry will not block other events that were queued). The client's callback handler must implement the state machine that can decide what to do with unexpected events, for example, "old" events or invalid state transitions. In these cases the handler could use the API to GET the latest state for the resource. The callback handler is expected to "ingest" the event and respond with 200 OK. The domain-specific business logic and processes should be executed outside of the callback request, as internal asynchronous jobs. An HMAC encrypted secret is used for hashing the payload and sending the hashed String via the X-Sinch-Signature header - that you can use to validate that an incoming request is secure. Hmac secret value can be checked with GET endpoint, and it can be updated with PUT endpoint
The endpoint receives as path param project id. Supports optional query parameters to narrow the results and cursor based pagination.
Status of the registration.
| Enum Value | Description |
|---|---|
| DRAFT | Registration not submitted by the customer. This functionality is not available through Public API, but it is possible to retrieve a registration created in the Sinch Customer Dashboard under the same project Id. |
| IN_QUEUE | Registration has been successfully submitted, but it is waiting for support. |
| IN_PROGRESS | Registration is being processing by Sinch. |
| APPROVED | Registration has been approved and sender ID has been provisioned for the customer. |
| REJECTED | Registration has been rejected. A comment should be present in the logs with the reason. |
| PENDING | Registration must be updated by the customer. Please check the registration logs to understand the reason. |
| ON_HOLD | Registration is on hold for any reason. Please check the comments in the logs. |
| PENDING_APPROVAL | For those policies with MANUAL price, Account Managers must approve the operation. Until registration has the approval it will stay in this state. |
| PENDING_ATTACHMENTS | Registration has been submitted, but at least one mandatory attachment must be provided. |
User tags used for the registration. Tag have to start from
Filter by ISO market code (ex. 'IT', 'AU', 'KW', etc.)
Date of registration creation, ISO 8601 format. Returns registrations created after given date.
Date of registration creation, ISO 8601 format. Returns registrations created before given date.
Date of registration update, ISO 8601 format. Returns registrations update after given date.
Date of registration update, ISO 8601 format. Returns registrations updated before given date.
Ordering of the results: field name with an optional order separated by a comma. Fields that support ordering are 'id', 'status', 'senderId', 'createDate', 'updateDate' with possible ordering 'desc' or 'asc'
Page token to request subsequent pages when using pagination. This should be the value generated by a system in a previous list request.
Registration type for market used in registration is for. There are different markets available depending on this type
| Enum Value | Description |
|---|---|
| ALPHANUMERIC_SENDER_ID | Alpha sender IDs |
| LONG_NUMBER | Long Numbers for SMS |
| SHORT_CODE | Short Codes for SMS |
| RCS_AGENT | RCS agent |
curl -i -X GET \
'https://senderid.registrations.api.sinch.com/v1/projects/{projectId}/registrations?registrationState=IN_QUEUE&tags=%23tag1%2C%23tag2&marketCode=MK&createDateFrom=2024-11-03&createDateTo=2024-11-03&updateDateFrom=2024-11-03&updateDateTo=2024-11-03&senderId=sender+ID&orderBy=senderId%2Casc&pageSize=100&pageToken=string®istrationType=ALPHANUMERIC_SENDER_ID' \
-H 'Authorization: Bearer <YOUR_TOKEN_HERE>'{ "nextPageToken": "string", "registrations": [ { … } ], "totalSize": 0 }
The endpoint creates a registration with specified policyId and registration's Data. The registration will be validated against the selected policy before submission. After this endpoint gets a 200, the registration will be in IN_QUEUE state, and will be editable. For those registrations that need attachments, they must be provided in a separated endpoint.
Webhook URL to specify an endpoint for delivery of notifications about registration updates
Email addresses that will be notified of any status changes of the registration.
Policy id that applies the registration.
Details of the sender IDs to be registered. Details depend on the specific market requirements defined in the policy.
User tags used for the registration. Tag have to start from '#' and contains only alphanumerics and dashes.
curl -i -X POST \
'https://senderid.registrations.api.sinch.com/v1/projects/{projectId}/registrations' \
-H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
-H 'Content-Type: application/json' \
-d '{
"callbackUrl": "senderid.registrations.api.sinch.com",
"notificationContacts": [
"jane.doe@example.com",
"john.doe@example.com"
],
"policyId": "d1c7ccbf-919d-462f-8587-dec95a1b11ee",
"requestDetails": [
{
"additionalDetails": [
{
"email": "email@mycompany.com"
},
{
"companyName": "My Company Name",
"website": "https://www.mycompany.com"
}
],
"senderIdDetails": [
{
"sender": "a sender value"
}
]
}
],
"tags": [
"#myTag1",
"#myTag2"
],
"servicePlanId": "a23dccbf-919d-462f-8587-dec95a1b44de"
}'OK
Webhook URL to specify an endpoint for delivery of notifications about registration updates
Creation time of the request. ISO date time format in UTC without timezone offset.
Email addresses that will be notified of any status changes of the registration.
Unique identifier of the policy for this registration.
Specify the sender ID type
| Enum Value | Description |
|---|---|
| ALPHANUMERIC_SENDER_ID | Alpha sender IDs |
| LONG_NUMBER | Long Numbers for SMS |
| SHORT_CODE | Short Codes for SMS |
| RCS_AGENT | RCS agent |
Details of the sender IDs to be registered. Details depend on the specific market requirements defined in the policy.
List of sender IDs associated with this registration. If sender IDs are not provided in the request, they will be assigned after registration approval.
Status of the registration.
| Enum Value | Description |
|---|---|
| DRAFT | Registration not submitted by the customer. This functionality is not available through Public API, but it is possible to retrieve a registration created in the Sinch Customer Dashboard under the same project Id. |
| IN_QUEUE | Registration has been successfully submitted, but it is waiting for support. |
| IN_PROGRESS | Registration is being processing by Sinch. |
| APPROVED | Registration has been approved and sender ID has been provisioned for the customer. |
| REJECTED | Registration has been rejected. A comment should be present in the logs with the reason. |
| PENDING | Registration must be updated by the customer. Please check the registration logs to understand the reason. |
| ON_HOLD | Registration is on hold for any reason. Please check the comments in the logs. |
| PENDING_APPROVAL | For those policies with MANUAL price, Account Managers must approve the operation. Until registration has the approval it will stay in this state. |
| PENDING_ATTACHMENTS | Registration has been submitted, but at least one mandatory attachment must be provided. |
User tags used for the registration. Tag have to start from '#' and contains only alphanumerics and dashes.
Update time of the request. ISO date time format in UTC without timezone offset.
{ "attachments": [ { … } ], "callbackUrl": "senderid.registrations.api.sinch.com", "createTime": "2021-11-03T14:30:03", "etaDate": "2024-11-03", "id": "d1c7ccbf-919d-462f-8587-dec95a1b11ee", "logs": [ { … } ], "notificationContacts": [ "jane.doe@example.com", "john.doe@example.com" ], "owner": "Jane Doe", "policyId": "d1c7ccbf-919d-462f-8587-dec95a1b11ee", "price": { "currency": "USD", "frequency": 1, "mode": "SUBSCRIBED", "recurrentFeeAmount": "2", "setupFeeAmount": "5" }, "registrationType": "ALPHANUMERIC_SENDER_ID", "requestDetails": [ { … } ], "senderIds": [ "senderId1", "senderId2" ], "status": "IN_QUEUE", "tags": [ "#myTag1", "#myTag2" ], "updateTime": "2021-11-03T14:30:03", "servicePlanId": "a23dccbf-919d-462f-8587-dec95a1b44de" }
curl -i -X DELETE \
'https://senderid.registrations.api.sinch.com/v1/projects/{projectId}/registrations/{registrationId}' \
-H 'Authorization: Bearer <YOUR_TOKEN_HERE>'curl -i -X GET \
'https://senderid.registrations.api.sinch.com/v1/projects/{projectId}/registrations/{registrationId}' \
-H 'Authorization: Bearer <YOUR_TOKEN_HERE>'OK
Webhook URL to specify an endpoint for delivery of notifications about registration updates
Creation time of the request. ISO date time format in UTC without timezone offset.
Email addresses that will be notified of any status changes of the registration.
Unique identifier of the policy for this registration.
Specify the sender ID type
| Enum Value | Description |
|---|---|
| ALPHANUMERIC_SENDER_ID | Alpha sender IDs |
| LONG_NUMBER | Long Numbers for SMS |
| SHORT_CODE | Short Codes for SMS |
| RCS_AGENT | RCS agent |
Details of the sender IDs to be registered. Details depend on the specific market requirements defined in the policy.
List of sender IDs associated with this registration. If sender IDs are not provided in the request, they will be assigned after registration approval.
Status of the registration.
| Enum Value | Description |
|---|---|
| DRAFT | Registration not submitted by the customer. This functionality is not available through Public API, but it is possible to retrieve a registration created in the Sinch Customer Dashboard under the same project Id. |
| IN_QUEUE | Registration has been successfully submitted, but it is waiting for support. |
| IN_PROGRESS | Registration is being processing by Sinch. |
| APPROVED | Registration has been approved and sender ID has been provisioned for the customer. |
| REJECTED | Registration has been rejected. A comment should be present in the logs with the reason. |
| PENDING | Registration must be updated by the customer. Please check the registration logs to understand the reason. |
| ON_HOLD | Registration is on hold for any reason. Please check the comments in the logs. |
| PENDING_APPROVAL | For those policies with MANUAL price, Account Managers must approve the operation. Until registration has the approval it will stay in this state. |
| PENDING_ATTACHMENTS | Registration has been submitted, but at least one mandatory attachment must be provided. |
User tags used for the registration. Tag have to start from '#' and contains only alphanumerics and dashes.
Update time of the request. ISO date time format in UTC without timezone offset.
{ "attachments": [ { … } ], "callbackUrl": "senderid.registrations.api.sinch.com", "createTime": "2021-11-03T14:30:03", "etaDate": "2024-11-03", "id": "d1c7ccbf-919d-462f-8587-dec95a1b11ee", "logs": [ { … } ], "notificationContacts": [ "jane.doe@example.com", "john.doe@example.com" ], "owner": "Jane Doe", "policyId": "d1c7ccbf-919d-462f-8587-dec95a1b11ee", "price": { "currency": "USD", "frequency": 1, "mode": "SUBSCRIBED", "recurrentFeeAmount": "2", "setupFeeAmount": "5" }, "registrationType": "ALPHANUMERIC_SENDER_ID", "requestDetails": [ { … } ], "senderIds": [ "senderId1", "senderId2" ], "status": "IN_QUEUE", "tags": [ "#myTag1", "#myTag2" ], "updateTime": "2021-11-03T14:30:03", "servicePlanId": "a23dccbf-919d-462f-8587-dec95a1b44de" }
Webhook URL to specify an endpoint for delivery of notifications about registration updates
Email addresses that will be notified of any status changes of the registration.
Details of the sender IDs to be registered. Details depend on the specific market requirements defined in the policy.
User tags used for the registration. Tag have to start from '#' and contains only alphanumerics and dashes.
curl -i -X PUT \
'https://senderid.registrations.api.sinch.com/v1/projects/{projectId}/registrations/{registrationId}' \
-H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
-H 'Content-Type: application/json' \
-d '{
"callbackUrl": "senderid.registrations.api.sinch.com",
"notificationContacts": [
"jane.doe@example.com",
"john.doe@example.com"
],
"requestDetails": [
{
"additionalDetails": [
{
"email": "email@mycompany.com"
},
{
"companyName": "My Company Name",
"website": "https://www.mycompany.com"
}
],
"senderIdDetails": [
{
"sender": "a sender value"
}
]
}
],
"tags": [
"#myTag1",
"#myTag2"
],
"servicePlanId": "a23dccbf-919d-462f-8587-dec95a1b44de"
}'OK
Webhook URL to specify an endpoint for delivery of notifications about registration updates
Creation time of the request. ISO date time format in UTC without timezone offset.
Email addresses that will be notified of any status changes of the registration.
Unique identifier of the policy for this registration.
Specify the sender ID type
| Enum Value | Description |
|---|---|
| ALPHANUMERIC_SENDER_ID | Alpha sender IDs |
| LONG_NUMBER | Long Numbers for SMS |
| SHORT_CODE | Short Codes for SMS |
| RCS_AGENT | RCS agent |
Details of the sender IDs to be registered. Details depend on the specific market requirements defined in the policy.
List of sender IDs associated with this registration. If sender IDs are not provided in the request, they will be assigned after registration approval.
Status of the registration.
| Enum Value | Description |
|---|---|
| DRAFT | Registration not submitted by the customer. This functionality is not available through Public API, but it is possible to retrieve a registration created in the Sinch Customer Dashboard under the same project Id. |
| IN_QUEUE | Registration has been successfully submitted, but it is waiting for support. |
| IN_PROGRESS | Registration is being processing by Sinch. |
| APPROVED | Registration has been approved and sender ID has been provisioned for the customer. |
| REJECTED | Registration has been rejected. A comment should be present in the logs with the reason. |
| PENDING | Registration must be updated by the customer. Please check the registration logs to understand the reason. |
| ON_HOLD | Registration is on hold for any reason. Please check the comments in the logs. |
| PENDING_APPROVAL | For those policies with MANUAL price, Account Managers must approve the operation. Until registration has the approval it will stay in this state. |
| PENDING_ATTACHMENTS | Registration has been submitted, but at least one mandatory attachment must be provided. |
User tags used for the registration. Tag have to start from '#' and contains only alphanumerics and dashes.
Update time of the request. ISO date time format in UTC without timezone offset.
{ "attachments": [ { … } ], "callbackUrl": "senderid.registrations.api.sinch.com", "createTime": "2021-11-03T14:30:03", "etaDate": "2024-11-03", "id": "d1c7ccbf-919d-462f-8587-dec95a1b11ee", "logs": [ { … } ], "notificationContacts": [ "jane.doe@example.com", "john.doe@example.com" ], "owner": "Jane Doe", "policyId": "d1c7ccbf-919d-462f-8587-dec95a1b11ee", "price": { "currency": "USD", "frequency": 1, "mode": "SUBSCRIBED", "recurrentFeeAmount": "2", "setupFeeAmount": "5" }, "registrationType": "ALPHANUMERIC_SENDER_ID", "requestDetails": [ { … } ], "senderIds": [ "senderId1", "senderId2" ], "status": "IN_QUEUE", "tags": [ "#myTag1", "#myTag2" ], "updateTime": "2021-11-03T14:30:03", "servicePlanId": "a23dccbf-919d-462f-8587-dec95a1b44de" }
curl -i -X GET \
https://senderid.registrations.api.sinch.com/v1/projects/eeew32344324edewe2e3/registrations/234235425jhl21132424lf/attachments/324234762423034240 \
-H 'Authorization: Bearer <YOUR_TOKEN_HERE>'No contentThrough this endpoint, attachments can be added to registrations. The required attachments for each registration can be retrieved from the get policy endpoint.
File content body
curl -i -X POST \
https://senderid.registrations.api.sinch.com/v1/projects/eeew32344324edewe2e3/registrations/234235425jhl21132424lf/attachments/324234762423034240 \
-H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
-H 'Content-Type: multipart/form-data' \
-d string