Add merchant principal

Add a Merchant Principal

curl --request POST \
  --url https://api.example.com/v1/crm/merchants/{merchantId}/principals \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "title": "<string>",
  "role": "<string>",
  "percentOwnership": 123,
  "firstName": "<string>",
  "lastName": "<string>",
  "email": "jsmith@example.com",
  "phoneNumber": "<string>",
  "dob": "<string>",
  "ssn": "<string>",
  "addressLabel": "<string>",
  "addressLine1": "<string>",
  "addressLine2": "<string>",
  "city": "<string>",
  "zip": "<string>",
  "country": "<string>",
  "bankruptcy": true,
  "isManagingDirector": true,
  "identificationId": "<string>",
  "identificationIssueDate": "<string>",
  "identificationExpiryDate": "<string>",
  "identificationIssuingCountry": "<string>"
}
'

import requests

url = "https://api.example.com/v1/crm/merchants/{merchantId}/principals"

payload = {
    "title": "<string>",
    "role": "<string>",
    "percentOwnership": 123,
    "firstName": "<string>",
    "lastName": "<string>",
    "email": "jsmith@example.com",
    "phoneNumber": "<string>",
    "dob": "<string>",
    "ssn": "<string>",
    "addressLabel": "<string>",
    "addressLine1": "<string>",
    "addressLine2": "<string>",
    "city": "<string>",
    "zip": "<string>",
    "country": "<string>",
    "bankruptcy": True,
    "isManagingDirector": True,
    "identificationId": "<string>",
    "identificationIssueDate": "<string>",
    "identificationExpiryDate": "<string>",
    "identificationIssuingCountry": "<string>"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    title: '<string>',
    role: '<string>',
    percentOwnership: 123,
    firstName: '<string>',
    lastName: '<string>',
    email: 'jsmith@example.com',
    phoneNumber: '<string>',
    dob: '<string>',
    ssn: '<string>',
    addressLabel: '<string>',
    addressLine1: '<string>',
    addressLine2: '<string>',
    city: '<string>',
    zip: '<string>',
    country: '<string>',
    bankruptcy: true,
    isManagingDirector: true,
    identificationId: '<string>',
    identificationIssueDate: '<string>',
    identificationExpiryDate: '<string>',
    identificationIssuingCountry: '<string>'
  })
};

fetch('https://api.example.com/v1/crm/merchants/{merchantId}/principals', 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://api.example.com/v1/crm/merchants/{merchantId}/principals",
  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([
    'title' => '<string>',
    'role' => '<string>',
    'percentOwnership' => 123,
    'firstName' => '<string>',
    'lastName' => '<string>',
    'email' => 'jsmith@example.com',
    'phoneNumber' => '<string>',
    'dob' => '<string>',
    'ssn' => '<string>',
    'addressLabel' => '<string>',
    'addressLine1' => '<string>',
    'addressLine2' => '<string>',
    'city' => '<string>',
    'zip' => '<string>',
    'country' => '<string>',
    'bankruptcy' => true,
    'isManagingDirector' => true,
    'identificationId' => '<string>',
    'identificationIssueDate' => '<string>',
    'identificationExpiryDate' => '<string>',
    'identificationIssuingCountry' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$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://api.example.com/v1/crm/merchants/{merchantId}/principals"

	payload := strings.NewReader("{\n  \"title\": \"<string>\",\n  \"role\": \"<string>\",\n  \"percentOwnership\": 123,\n  \"firstName\": \"<string>\",\n  \"lastName\": \"<string>\",\n  \"email\": \"jsmith@example.com\",\n  \"phoneNumber\": \"<string>\",\n  \"dob\": \"<string>\",\n  \"ssn\": \"<string>\",\n  \"addressLabel\": \"<string>\",\n  \"addressLine1\": \"<string>\",\n  \"addressLine2\": \"<string>\",\n  \"city\": \"<string>\",\n  \"zip\": \"<string>\",\n  \"country\": \"<string>\",\n  \"bankruptcy\": true,\n  \"isManagingDirector\": true,\n  \"identificationId\": \"<string>\",\n  \"identificationIssueDate\": \"<string>\",\n  \"identificationExpiryDate\": \"<string>\",\n  \"identificationIssuingCountry\": \"<string>\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	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://api.example.com/v1/crm/merchants/{merchantId}/principals")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"title\": \"<string>\",\n  \"role\": \"<string>\",\n  \"percentOwnership\": 123,\n  \"firstName\": \"<string>\",\n  \"lastName\": \"<string>\",\n  \"email\": \"jsmith@example.com\",\n  \"phoneNumber\": \"<string>\",\n  \"dob\": \"<string>\",\n  \"ssn\": \"<string>\",\n  \"addressLabel\": \"<string>\",\n  \"addressLine1\": \"<string>\",\n  \"addressLine2\": \"<string>\",\n  \"city\": \"<string>\",\n  \"zip\": \"<string>\",\n  \"country\": \"<string>\",\n  \"bankruptcy\": true,\n  \"isManagingDirector\": true,\n  \"identificationId\": \"<string>\",\n  \"identificationIssueDate\": \"<string>\",\n  \"identificationExpiryDate\": \"<string>\",\n  \"identificationIssuingCountry\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.example.com/v1/crm/merchants/{merchantId}/principals")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"title\": \"<string>\",\n  \"role\": \"<string>\",\n  \"percentOwnership\": 123,\n  \"firstName\": \"<string>\",\n  \"lastName\": \"<string>\",\n  \"email\": \"jsmith@example.com\",\n  \"phoneNumber\": \"<string>\",\n  \"dob\": \"<string>\",\n  \"ssn\": \"<string>\",\n  \"addressLabel\": \"<string>\",\n  \"addressLine1\": \"<string>\",\n  \"addressLine2\": \"<string>\",\n  \"city\": \"<string>\",\n  \"zip\": \"<string>\",\n  \"country\": \"<string>\",\n  \"bankruptcy\": true,\n  \"isManagingDirector\": true,\n  \"identificationId\": \"<string>\",\n  \"identificationIssueDate\": \"<string>\",\n  \"identificationExpiryDate\": \"<string>\",\n  \"identificationIssuingCountry\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body

{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "clientId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "title": "<string>",
  "role": "<string>",
  "percentOwnership": 123,
  "firstName": "<string>",
  "lastName": "<string>",
  "email": "jsmith@example.com",
  "phoneNumber": "<string>",
  "dob": "<string>",
  "ssn": "<string>",
  "hashedSsn": "<string>",
  "addressLabel": "<string>",
  "addressLine1": "<string>",
  "addressLine2": "<string>",
  "city": "<string>",
  "state": "<string>",
  "zip": "<string>",
  "country": "<string>",
  "validationStatus": "not_validated",
  "bankruptcy": true,
  "isManagingDirector": true,
  "identificationType": "driving_license",
  "identificationId": "<string>",
  "identificationIssueDate": "<string>",
  "identificationExpiryDate": "<string>",
  "identificationIssuingState": "<string>",
  "identificationIssuingCountry": "<string>"
}

{
  "status": 123,
  "code": "<string>",
  "detail": "<string>"
}

{
  "status": 123,
  "code": "<string>",
  "detail": "<string>"
}

POST

crm

merchants

{merchantId}

principals

Add a Merchant Principal

curl --request POST \
  --url https://api.example.com/v1/crm/merchants/{merchantId}/principals \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "title": "<string>",
  "role": "<string>",
  "percentOwnership": 123,
  "firstName": "<string>",
  "lastName": "<string>",
  "email": "jsmith@example.com",
  "phoneNumber": "<string>",
  "dob": "<string>",
  "ssn": "<string>",
  "addressLabel": "<string>",
  "addressLine1": "<string>",
  "addressLine2": "<string>",
  "city": "<string>",
  "zip": "<string>",
  "country": "<string>",
  "bankruptcy": true,
  "isManagingDirector": true,
  "identificationId": "<string>",
  "identificationIssueDate": "<string>",
  "identificationExpiryDate": "<string>",
  "identificationIssuingCountry": "<string>"
}
'

import requests

url = "https://api.example.com/v1/crm/merchants/{merchantId}/principals"

payload = {
    "title": "<string>",
    "role": "<string>",
    "percentOwnership": 123,
    "firstName": "<string>",
    "lastName": "<string>",
    "email": "jsmith@example.com",
    "phoneNumber": "<string>",
    "dob": "<string>",
    "ssn": "<string>",
    "addressLabel": "<string>",
    "addressLine1": "<string>",
    "addressLine2": "<string>",
    "city": "<string>",
    "zip": "<string>",
    "country": "<string>",
    "bankruptcy": True,
    "isManagingDirector": True,
    "identificationId": "<string>",
    "identificationIssueDate": "<string>",
    "identificationExpiryDate": "<string>",
    "identificationIssuingCountry": "<string>"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    title: '<string>',
    role: '<string>',
    percentOwnership: 123,
    firstName: '<string>',
    lastName: '<string>',
    email: 'jsmith@example.com',
    phoneNumber: '<string>',
    dob: '<string>',
    ssn: '<string>',
    addressLabel: '<string>',
    addressLine1: '<string>',
    addressLine2: '<string>',
    city: '<string>',
    zip: '<string>',
    country: '<string>',
    bankruptcy: true,
    isManagingDirector: true,
    identificationId: '<string>',
    identificationIssueDate: '<string>',
    identificationExpiryDate: '<string>',
    identificationIssuingCountry: '<string>'
  })
};

fetch('https://api.example.com/v1/crm/merchants/{merchantId}/principals', 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://api.example.com/v1/crm/merchants/{merchantId}/principals",
  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([
    'title' => '<string>',
    'role' => '<string>',
    'percentOwnership' => 123,
    'firstName' => '<string>',
    'lastName' => '<string>',
    'email' => 'jsmith@example.com',
    'phoneNumber' => '<string>',
    'dob' => '<string>',
    'ssn' => '<string>',
    'addressLabel' => '<string>',
    'addressLine1' => '<string>',
    'addressLine2' => '<string>',
    'city' => '<string>',
    'zip' => '<string>',
    'country' => '<string>',
    'bankruptcy' => true,
    'isManagingDirector' => true,
    'identificationId' => '<string>',
    'identificationIssueDate' => '<string>',
    'identificationExpiryDate' => '<string>',
    'identificationIssuingCountry' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$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://api.example.com/v1/crm/merchants/{merchantId}/principals"

	payload := strings.NewReader("{\n  \"title\": \"<string>\",\n  \"role\": \"<string>\",\n  \"percentOwnership\": 123,\n  \"firstName\": \"<string>\",\n  \"lastName\": \"<string>\",\n  \"email\": \"jsmith@example.com\",\n  \"phoneNumber\": \"<string>\",\n  \"dob\": \"<string>\",\n  \"ssn\": \"<string>\",\n  \"addressLabel\": \"<string>\",\n  \"addressLine1\": \"<string>\",\n  \"addressLine2\": \"<string>\",\n  \"city\": \"<string>\",\n  \"zip\": \"<string>\",\n  \"country\": \"<string>\",\n  \"bankruptcy\": true,\n  \"isManagingDirector\": true,\n  \"identificationId\": \"<string>\",\n  \"identificationIssueDate\": \"<string>\",\n  \"identificationExpiryDate\": \"<string>\",\n  \"identificationIssuingCountry\": \"<string>\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	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://api.example.com/v1/crm/merchants/{merchantId}/principals")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"title\": \"<string>\",\n  \"role\": \"<string>\",\n  \"percentOwnership\": 123,\n  \"firstName\": \"<string>\",\n  \"lastName\": \"<string>\",\n  \"email\": \"jsmith@example.com\",\n  \"phoneNumber\": \"<string>\",\n  \"dob\": \"<string>\",\n  \"ssn\": \"<string>\",\n  \"addressLabel\": \"<string>\",\n  \"addressLine1\": \"<string>\",\n  \"addressLine2\": \"<string>\",\n  \"city\": \"<string>\",\n  \"zip\": \"<string>\",\n  \"country\": \"<string>\",\n  \"bankruptcy\": true,\n  \"isManagingDirector\": true,\n  \"identificationId\": \"<string>\",\n  \"identificationIssueDate\": \"<string>\",\n  \"identificationExpiryDate\": \"<string>\",\n  \"identificationIssuingCountry\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.example.com/v1/crm/merchants/{merchantId}/principals")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"title\": \"<string>\",\n  \"role\": \"<string>\",\n  \"percentOwnership\": 123,\n  \"firstName\": \"<string>\",\n  \"lastName\": \"<string>\",\n  \"email\": \"jsmith@example.com\",\n  \"phoneNumber\": \"<string>\",\n  \"dob\": \"<string>\",\n  \"ssn\": \"<string>\",\n  \"addressLabel\": \"<string>\",\n  \"addressLine1\": \"<string>\",\n  \"addressLine2\": \"<string>\",\n  \"city\": \"<string>\",\n  \"zip\": \"<string>\",\n  \"country\": \"<string>\",\n  \"bankruptcy\": true,\n  \"isManagingDirector\": true,\n  \"identificationId\": \"<string>\",\n  \"identificationIssueDate\": \"<string>\",\n  \"identificationExpiryDate\": \"<string>\",\n  \"identificationIssuingCountry\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body

{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "clientId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "title": "<string>",
  "role": "<string>",
  "percentOwnership": 123,
  "firstName": "<string>",
  "lastName": "<string>",
  "email": "jsmith@example.com",
  "phoneNumber": "<string>",
  "dob": "<string>",
  "ssn": "<string>",
  "hashedSsn": "<string>",
  "addressLabel": "<string>",
  "addressLine1": "<string>",
  "addressLine2": "<string>",
  "city": "<string>",
  "state": "<string>",
  "zip": "<string>",
  "country": "<string>",
  "validationStatus": "not_validated",
  "bankruptcy": true,
  "isManagingDirector": true,
  "identificationType": "driving_license",
  "identificationId": "<string>",
  "identificationIssueDate": "<string>",
  "identificationExpiryDate": "<string>",
  "identificationIssuingState": "<string>",
  "identificationIssuingCountry": "<string>"
}

{
  "status": 123,
  "code": "<string>",
  "detail": "<string>"
}

{
  "status": 123,
  "code": "<string>",
  "detail": "<string>"
}

Authorizations

Authorization

string

header

required

Enter token in following format: Bearer

Path Parameters

merchantId

string

required

Body

application/json

title

string | null

Maximum string length: 80

role

string | null

Maximum string length: 50

percentOwnership

number | null

firstName

string | null

Maximum string length: 80

lastName

string | null

Maximum string length: 80

string<email> | null

Maximum string length: 256

Pattern: ^(?!\.)(?!.*\.\.)([A-Za-z0-9_'+\-\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\-]*\.)+[A-Za-z]{2,}$

phoneNumber

string | null

Pattern: ^\+1\d{10}$

dob

string | null

ssn

string | null

addressLabel

string | null

Maximum string length: 80

addressLine1

string | null

Maximum string length: 100

addressLine2

string | null

Maximum string length: 50

city

string | null

Maximum string length: 50

state

enum<string> | null

Available options:

AL,

AK,

AZ,

AR,

CA,

CO,

CT,

DE,

DC,

FL,

GA,

HI,

ID,

IL,

IN,

IA,

KS,

KY,

LA,

ME,

MD,

MA,

MI,

MN,

MS,

MO,

MT,

NE,

NV,

NH,

NJ,

NM,

NY,

NC,

ND,

OH,

OK,

OR,

PA,

RI,

SC,

SD,

TN,

TX,

UT,

VT,

VA,

WA,

WV,

WI,

WY

Required string length: 1 - 2

zip

string | null

Maximum string length: 10

country

string | null

Maximum string length: 2

validationStatus

enum<string> | null

Available options:

not_validated,

validated,

invalid

bankruptcy

boolean | null

isManagingDirector

boolean | null

identificationType

enum<string> | null

Available options:

driving_license,

driving_permit,

id_card,

passport

identificationId

string | null

Maximum string length: 25

identificationIssueDate

string | null

identificationExpiryDate

string | null

identificationIssuingState

enum<string> | null

Available options:

AL,

AK,

AZ,

AR,

CA,

CO,

CT,

DE,

DC,

FL,

GA,

HI,

ID,

IL,

IN,

IA,

KS,

KY,

LA,

ME,

MD,

MA,

MI,

MN,

MS,

MO,

MT,

NE,

NV,

NH,

NJ,

NM,

NY,

NC,

ND,

OH,

OK,

OR,

PA,

RI,

SC,

SD,

TN,

TX,

UT,

VT,

VA,

WA,

WV,

WI,

WY

Required string length: 1 - 2

identificationIssuingCountry

string | null

Maximum string length: 2

Response

The created principal for the merchant.

string<uuid>

required

Pattern:

^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$

clientId

string<uuid>

required

Pattern:

^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$

title

string | null

Maximum string length: 80

role

string | null

Maximum string length: 50

percentOwnership

number | null

firstName

string | null

Maximum string length: 80

lastName

string | null

Maximum string length: 80

string<email> | null

Maximum string length: 256

Pattern: ^(?!\.)(?!.*\.\.)([A-Za-z0-9_'+\-\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\-]*\.)+[A-Za-z]{2,}$

phoneNumber

string | null

Maximum string length: 32

dob

string | null

ssn

string | null

hashedSsn

string | null

addressLabel

string | null

Maximum string length: 80

addressLine1

string | null

Maximum string length: 100

addressLine2

string | null

Maximum string length: 50

city

string | null

Maximum string length: 50

state

string | null

Maximum string length: 2

zip

string | null

Maximum string length: 10

country

string | null

Maximum string length: 2

validationStatus

enum<string> | null

Available options:

not_validated,

validated,

invalid

bankruptcy

boolean | null

isManagingDirector

boolean | null

identificationType

enum<string> | null

Available options:

driving_license,

driving_permit,

id_card,

passport

identificationId

string | null

Maximum string length: 25

identificationIssueDate

string | null

identificationExpiryDate

string | null

identificationIssuingState

string | null

Maximum string length: 2

identificationIssuingCountry

string | null

Maximum string length: 2

API Reference

Agents

Applications

Deployments

Merchants

Partners

Reporting

Tickets

Authorizations

Path Parameters

Body

Response