Create Customer

post

https://api.authvia.com/v3/accounts/{account-id}/customers

🔑
scope customers:create

Create a new Customer for the specified Account (Merchant). This endpoint allows you to establish a customer relationship and store customer information for future interactions.

📘
Info
The ref field is required and must be unique within your account. This reference will be used to identify the customer in subsequent API calls.
You can add customer addresses and metadata during creation or update them later using the respective endpoints.

💡
Tip: For bulk customer creation, consider using the SFTP bulk operations which allow you to upload CSV files for large-scale customer onboarding.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

account-id

string

required

The unique identifier (AVID) of the Account.

Body Params

Payload for creating a customer

ref

string

required

length ≥ 1

The reference may serve as a unique identifier for a customer within the account (merchant) because it is used and available during operations such as transactions.

addresses

array of objects

required

length ≥ 1

Allow multiple addresses to be linked to the customer. However, the order of the addresses is important, as the first one is always selected as the default.

addresses*

value

required

The address value must be a valid address-format: either in E.164 format for phone numbers or as a valid email address. This is necessary for customer login and receiving messages.

Value should be a valid email address.

metadata

object

Add additional information associated with the customer like name, location etc. A special mention to the customers/crm/authvia product which can enable a signup form for customers to self sign up and/or add validation checking for each customer created.

appdata

object

A merchant can add extra details for a customer, such as notes, references, secret etc, which are not visible to the customer. This attribute is only deliviered on webhook payloads and returned for API calls to load a customer record.

Responses

Language

Credentials

Header

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

Create Customer

scope `customers:create`

Info

Tip: For bulk customer creation, consider using the SFTP bulk operations which allow you to upload CSV files for large-scale customer onboarding.

201Successfully created customer. Returns the complete customer details including profile, addresses, and metadata.

400Bad Request - The request cannot be processed due to a client error (e.g., malformed request syntax, invalid request message framing, or deceptive request routing).

401The request is valid, but server authentication failed to verify the identity. The user's access token has either expired or is not valid. Creating a new token might resolve the issue.