Subscriber

A Subscriber is an individual or entity that has entered into an agreement with a service provider to receive communication services. This relationship is formalized through a subscription, which includes the following details:

• Personal Information: This encompasses the subscriber's name, address, and other relevant personal information

• Contact Details: Includes phone numbers, email addresses, and other means of communication to facilitate interaction between the subscriber and the service provider.

• Identification Information: Comprises identification numbers or documents, such as national ID numbers, passports, or business registration numbers, used to verify the subscriber's identity.

It's important to note that the specific information collected from subscribers can vary significantly from country to country, influenced by local Know Your Customer (KYC) regulations and other regulatory requirements.

Address format

Addresses are represented with the following fields:

• line1: The primary address information. For European countries, line1 must contain both the street name and house/building number. A subscriber cannot be created without a house/building number in line1.
• line2 (optional): Any additional address information the customer wants to provide, such as building name, neighborhood, floor, or apartment number. line2 does not need to be provided — what matters is that line1 is correct and complete.
• city: The city.
• postal_code: The postal or ZIP code.
• country: The country, represented as its two-character ISO 3166-1 alpha-2 code.
• state (required for US and Canada only): The state or province. This field only applies to addresses in the United States and Canada.

Example (Netherlands):

API Reference

See the full list of endpoints, request and response schemas, examples, and version information in the Subscribers section of the API Reference.