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: <api-key>' \
--header 'X-Meridian-Timestamp: <x-meridian-timestamp>' \
--data '
{
"externalId": "partner-user-123",
"person": {
"firstName": "Jane",
"lastName": "Doe",
"contactPhone": "+15551234567",
"contactEmail": "jane.doe@example.com",
"dateOfBirth": "1990-01-15"
}
}
'import requests
url = "https://sandbox-api.va.meridianpay.com/v1/auth/users"
payload = {
"externalId": "partner-user-123",
"person": {
"firstName": "Jane",
"lastName": "Doe",
"contactPhone": "+15551234567",
"contactEmail": "jane.doe@example.com",
"dateOfBirth": "1990-01-15"
}
}
headers = {
"X-Meridian-Api-Key": "<x-meridian-api-key>",
"X-Meridian-Timestamp": "<x-meridian-timestamp>",
"X-Meridian-Program-Id": "<x-meridian-program-id>",
"X-Meridian-Signature": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {
'X-Meridian-Api-Key': '<x-meridian-api-key>',
'X-Meridian-Timestamp': '<x-meridian-timestamp>',
'X-Meridian-Program-Id': '<x-meridian-program-id>',
'X-Meridian-Signature': '<api-key>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
externalId: 'partner-user-123',
person: {
firstName: 'Jane',
lastName: 'Doe',
contactPhone: '+15551234567',
contactEmail: 'jane.doe@example.com',
dateOfBirth: '1990-01-15'
}
})
};
fetch('https://sandbox-api.va.meridianpay.com/v1/auth/users', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://sandbox-api.va.meridianpay.com/v1/auth/users",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'externalId' => 'partner-user-123',
'person' => [
'firstName' => 'Jane',
'lastName' => 'Doe',
'contactPhone' => '+15551234567',
'contactEmail' => 'jane.doe@example.com',
'dateOfBirth' => '1990-01-15'
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"X-Meridian-Api-Key: <x-meridian-api-key>",
"X-Meridian-Program-Id: <x-meridian-program-id>",
"X-Meridian-Signature: <api-key>",
"X-Meridian-Timestamp: <x-meridian-timestamp>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://sandbox-api.va.meridianpay.com/v1/auth/users"
payload := strings.NewReader("{\n \"externalId\": \"partner-user-123\",\n \"person\": {\n \"firstName\": \"Jane\",\n \"lastName\": \"Doe\",\n \"contactPhone\": \"+15551234567\",\n \"contactEmail\": \"jane.doe@example.com\",\n \"dateOfBirth\": \"1990-01-15\"\n }\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("X-Meridian-Api-Key", "<x-meridian-api-key>")
req.Header.Add("X-Meridian-Timestamp", "<x-meridian-timestamp>")
req.Header.Add("X-Meridian-Program-Id", "<x-meridian-program-id>")
req.Header.Add("X-Meridian-Signature", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://sandbox-api.va.meridianpay.com/v1/auth/users")
.header("X-Meridian-Api-Key", "<x-meridian-api-key>")
.header("X-Meridian-Timestamp", "<x-meridian-timestamp>")
.header("X-Meridian-Program-Id", "<x-meridian-program-id>")
.header("X-Meridian-Signature", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"externalId\": \"partner-user-123\",\n \"person\": {\n \"firstName\": \"Jane\",\n \"lastName\": \"Doe\",\n \"contactPhone\": \"+15551234567\",\n \"contactEmail\": \"jane.doe@example.com\",\n \"dateOfBirth\": \"1990-01-15\"\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://sandbox-api.va.meridianpay.com/v1/auth/users")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["X-Meridian-Api-Key"] = '<x-meridian-api-key>'
request["X-Meridian-Timestamp"] = '<x-meridian-timestamp>'
request["X-Meridian-Program-Id"] = '<x-meridian-program-id>'
request["X-Meridian-Signature"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"externalId\": \"partner-user-123\",\n \"person\": {\n \"firstName\": \"Jane\",\n \"lastName\": \"Doe\",\n \"contactPhone\": \"+15551234567\",\n \"contactEmail\": \"jane.doe@example.com\",\n \"dateOfBirth\": \"1990-01-15\"\n }\n}"
response = http.request(request)
puts response.read_body{
"userId": "user_123"
}{
"message": "<string>",
"validationErrors": [
{
"fieldRef": "<string>",
"type": "InvalidFormat",
"message": "<string>"
}
],
"errorCode": "UNAUTHORIZED"
}{
"message": "<string>",
"validationErrors": [
{
"fieldRef": "<string>",
"type": "InvalidFormat",
"message": "<string>"
}
],
"errorCode": "UNAUTHORIZED"
}{
"message": "<string>",
"validationErrors": [
{
"fieldRef": "<string>",
"type": "InvalidFormat",
"message": "<string>"
}
],
"errorCode": "UNAUTHORIZED"
}{
"message": "<string>",
"validationErrors": [
{
"fieldRef": "<string>",
"type": "InvalidFormat",
"message": "<string>"
}
],
"errorCode": "UNAUTHORIZED"
}Create a Meridian user for a partner
Creates a person or business user for the calling partner on the supplied program. Only MULTI_USER integrations may call this endpoint; SINGLE_USER keys are rejected.
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: <api-key>' \
--header 'X-Meridian-Timestamp: <x-meridian-timestamp>' \
--data '
{
"externalId": "partner-user-123",
"person": {
"firstName": "Jane",
"lastName": "Doe",
"contactPhone": "+15551234567",
"contactEmail": "jane.doe@example.com",
"dateOfBirth": "1990-01-15"
}
}
'import requests
url = "https://sandbox-api.va.meridianpay.com/v1/auth/users"
payload = {
"externalId": "partner-user-123",
"person": {
"firstName": "Jane",
"lastName": "Doe",
"contactPhone": "+15551234567",
"contactEmail": "jane.doe@example.com",
"dateOfBirth": "1990-01-15"
}
}
headers = {
"X-Meridian-Api-Key": "<x-meridian-api-key>",
"X-Meridian-Timestamp": "<x-meridian-timestamp>",
"X-Meridian-Program-Id": "<x-meridian-program-id>",
"X-Meridian-Signature": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {
'X-Meridian-Api-Key': '<x-meridian-api-key>',
'X-Meridian-Timestamp': '<x-meridian-timestamp>',
'X-Meridian-Program-Id': '<x-meridian-program-id>',
'X-Meridian-Signature': '<api-key>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
externalId: 'partner-user-123',
person: {
firstName: 'Jane',
lastName: 'Doe',
contactPhone: '+15551234567',
contactEmail: 'jane.doe@example.com',
dateOfBirth: '1990-01-15'
}
})
};
fetch('https://sandbox-api.va.meridianpay.com/v1/auth/users', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://sandbox-api.va.meridianpay.com/v1/auth/users",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'externalId' => 'partner-user-123',
'person' => [
'firstName' => 'Jane',
'lastName' => 'Doe',
'contactPhone' => '+15551234567',
'contactEmail' => 'jane.doe@example.com',
'dateOfBirth' => '1990-01-15'
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"X-Meridian-Api-Key: <x-meridian-api-key>",
"X-Meridian-Program-Id: <x-meridian-program-id>",
"X-Meridian-Signature: <api-key>",
"X-Meridian-Timestamp: <x-meridian-timestamp>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://sandbox-api.va.meridianpay.com/v1/auth/users"
payload := strings.NewReader("{\n \"externalId\": \"partner-user-123\",\n \"person\": {\n \"firstName\": \"Jane\",\n \"lastName\": \"Doe\",\n \"contactPhone\": \"+15551234567\",\n \"contactEmail\": \"jane.doe@example.com\",\n \"dateOfBirth\": \"1990-01-15\"\n }\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("X-Meridian-Api-Key", "<x-meridian-api-key>")
req.Header.Add("X-Meridian-Timestamp", "<x-meridian-timestamp>")
req.Header.Add("X-Meridian-Program-Id", "<x-meridian-program-id>")
req.Header.Add("X-Meridian-Signature", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://sandbox-api.va.meridianpay.com/v1/auth/users")
.header("X-Meridian-Api-Key", "<x-meridian-api-key>")
.header("X-Meridian-Timestamp", "<x-meridian-timestamp>")
.header("X-Meridian-Program-Id", "<x-meridian-program-id>")
.header("X-Meridian-Signature", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"externalId\": \"partner-user-123\",\n \"person\": {\n \"firstName\": \"Jane\",\n \"lastName\": \"Doe\",\n \"contactPhone\": \"+15551234567\",\n \"contactEmail\": \"jane.doe@example.com\",\n \"dateOfBirth\": \"1990-01-15\"\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://sandbox-api.va.meridianpay.com/v1/auth/users")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["X-Meridian-Api-Key"] = '<x-meridian-api-key>'
request["X-Meridian-Timestamp"] = '<x-meridian-timestamp>'
request["X-Meridian-Program-Id"] = '<x-meridian-program-id>'
request["X-Meridian-Signature"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"externalId\": \"partner-user-123\",\n \"person\": {\n \"firstName\": \"Jane\",\n \"lastName\": \"Doe\",\n \"contactPhone\": \"+15551234567\",\n \"contactEmail\": \"jane.doe@example.com\",\n \"dateOfBirth\": \"1990-01-15\"\n }\n}"
response = http.request(request)
puts response.read_body{
"userId": "user_123"
}{
"message": "<string>",
"validationErrors": [
{
"fieldRef": "<string>",
"type": "InvalidFormat",
"message": "<string>"
}
],
"errorCode": "UNAUTHORIZED"
}{
"message": "<string>",
"validationErrors": [
{
"fieldRef": "<string>",
"type": "InvalidFormat",
"message": "<string>"
}
],
"errorCode": "UNAUTHORIZED"
}{
"message": "<string>",
"validationErrors": [
{
"fieldRef": "<string>",
"type": "InvalidFormat",
"message": "<string>"
}
],
"errorCode": "UNAUTHORIZED"
}{
"message": "<string>",
"validationErrors": [
{
"fieldRef": "<string>",
"type": "InvalidFormat",
"message": "<string>"
}
],
"errorCode": "UNAUTHORIZED"
}Authorizations
Meridian HMAC header authentication, for server-to-server calls.
Required headers:
X-Meridian-Api-KeyX-Meridian-TimestampX-Meridian-Program-IdX-Meridian-User-Id(MULTI_USER integrations only)X-Meridian-Signature
X-Meridian-Signature is the HMAC SHA-256 signature of the canonical request string, computed per request. See Authentication for how to construct it.
Headers
Server-to-server (HMAC) requests only. Partner API key issued by Meridian during provisioning.
Server-to-server (HMAC) requests only. Current time in milliseconds since the Unix epoch. Must be within 60 seconds of the request.
Server-to-server (HMAC) requests only. Identifies the program context for the request.
Server-to-server (HMAC) requests only. Identifies the Meridian user targeted by the request. Required for MULTI_USER integrations; omit for SINGLE_USER.
Body
Person or business user payload
- Person User Input
- Business User Input
Meridian person user creation payload
Response
The id of the newly created user
Response containing the created Meridian user identifier
Created Meridian user identifier
"user_123"