Skip to main content
POST
/
v1
/
auth
/
users
Create a Meridian user for a partner
curl --request POST \
  --url https://sandbox-api.va.meridianpay.com/v1/auth/users \
  --header 'Content-Type: application/json' \
  --header 'X-Meridian-Api-Key: <x-meridian-api-key>' \
  --header 'X-Meridian-Program-Id: <x-meridian-program-id>' \
  --header 'X-Meridian-Signature: <x-meridian-signature>' \
  --header 'X-Meridian-Timestamp: <x-meridian-timestamp>' \
  --data '
{
  "externalId": "<string>",
  "business": {
    "legalName": "Acme Inc",
    "contactPhone": "+15551234567",
    "contactEmail": "ops@acme.example"
  }
}
'
{
  "userId": "user_123"
}

Headers

​
X-Meridian-Program-Id
string
required

Identifies the program context for the request. Required for server-to-server (HMAC) authentication. See Authentication.

​
X-Meridian-User-Id
string

Identifies the Meridian user targeted by the request. Required for server-to-server (HMAC) authentication with MULTI_USER integrations; omit for SINGLE_USER. See Authentication.

​
X-Meridian-Api-Key
string
required

Partner API key issued by Meridian during provisioning. Required for server-to-server (HMAC) authentication. See Authentication.

​
X-Meridian-Timestamp
string
required

Current time in milliseconds since the Unix epoch. Must be within 60 seconds of the request. Required for server-to-server (HMAC) authentication. See Authentication.

​
X-Meridian-Signature
string
required

HMAC SHA-256 signature of the canonical request string, computed per request. Required for server-to-server (HMAC) authentication. See Authentication for how to construct it.

Body

application/json

Person or business user payload

Meridian business user creation payload

​
externalId
string
required
​
business
Business Profile · object
required

Business profile data

​
type
enum<string>
Available options:
PERSON,
BUSINESS

Response

The id of the newly created user

Response containing the created Meridian user identifier

​
userId
string
required

Created Meridian user identifier

Example:

"user_123"