Create Sender

Overview

  • Creates a new sender
  • Supports both individual and business senders
  • Requirements vary by country and ownerType

Validation Rules

  • Important: Always check validation rules before creating a sender
  • Validation rules endpoint: GET /v1/validation-rules/senders
  • Required query parameters:
    • ownerType=[individual|business]
    • country=[ISO 3166-1 alpha-2 code]
  • Example request:
GET /v1/validation-rules/senders?ownerType=individual&country=MX
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params

Individual sender information. Note: Document requirements (documentFront, documentBack) vary by country. Please refer to the validation-rules endpoint with ownerType='individual' and the specific country to determine exact documentation requirements.

string
enum
required
Defaults to individual

Type of the sender.

Allowed:
string
required

First name of the individual sender.

string
required

Last name of the individual sender.

date
required

Birth date in ISO 8601 format (YYYY-MM-DD).

string
required

Email address of the sender.

string
required

A phone number in international format (e.g., +11234567890).

addresses
array of objects
required

Array of addresses for the sender.

addresses*
identity
object
required
uri

Website URL of the individual or business.

metadata
object

Additional custom metadata for the sender account.

string
enum
required

Gender of the sender

Allowed:
string
enum
required

Occupation of the sender

string

Middle name of the sender

uuid

Merchant ID (optional, auto-assigned from API key)

Responses

Language
Credentials
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json