Sign inBook a demo
HomeGuidesAPI ReferenceGlossary
HomeGuidesAPI ReferenceGlossary
  • API Reference
Logo
Sign inBook a demo
API ReferenceEntityRepresentative

Create

POST
https://api.mercoa.com/entity/:entityId/representative
POST
/entity/:entityId/representative
1curl -X POST https://api.mercoa.com/entity/ent_8545a84e-a45f-41bf-bdf1-33b42a55812c/representative \
2     -H "Authorization: Bearer <token>" \
3     -H "Content-Type: application/json" \
4     -d '{
5  "name": {
6    "firstName": "John",
7    "lastName": "Adams",
8    "middleName": "Quincy",
9    "suffix": "Jr."
10  },
11  "address": {
12    "addressLine1": "123 Main St",
13    "city": "San Francisco",
14    "stateOrProvince": "CA",
15    "postalCode": "94105",
16    "addressLine2": "Unit 1",
17    "country": "US"
18  },
19  "birthDate": {
20    "day": "1",
21    "month": "1",
22    "year": "1980"
23  },
24  "governmentID": {
25    "ssn": "123-45-6789"
26  },
27  "responsibilities": {
28    "isController": true,
29    "isOwner": true,
30    "ownershipPercentage": 40
31  },
32  "phone": {
33    "countryCode": "1",
34    "number": "4155551234"
35  },
36  "email": "john.doe@acme.com"
37}'
Try it
200BusinessPayorRepresentative
1{
2  "id": "rep_7df2974a-4069-454c-912f-7e58ebe030fb",
3  "name": {
4    "firstName": "John",
5    "lastName": "Adams",
6    "middleName": "Quincy",
7    "suffix": "Jr."
8  },
9  "address": {
10    "addressLine1": "123 Main St",
11    "city": "San Francisco",
12    "stateOrProvince": "CA",
13    "postalCode": "94105",
14    "addressLine2": "Unit 1",
15    "country": "US"
16  },
17  "birthDateProvided": true,
18  "governmentIDProvided": true,
19  "responsibilities": {
20    "isController": true,
21    "isOwner": true,
22    "ownershipPercentage": 40
23  },
24  "createdOn": "2024-01-01T00:00:00Z",
25  "updatedOn": "2024-01-01T00:00:00Z",
26  "phone": {
27    "countryCode": "1",
28    "number": "4155551234"
29  },
30  "email": "john.doe@acme.com",
31  "disabledOn": null
32}
Was this page helpful?
Previous

Get

Next
Built with
Get

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

entityIdstringRequired
Entity ID or Entity ForeignID

Request

This endpoint expects an object.
nameobjectRequired
addressobjectRequired
birthDateobjectRequired
governmentIDobjectRequired
responsibilitiesobjectRequired
phoneobjectOptional
Either phone or email is required.
emailstringOptional
Either phone or email is required.

Response

This endpoint returns an object.
idstring
nameobject
addressobject
birthDateProvidedboolean
governmentIDProvidedboolean
responsibilitiesobject
createdOndatetime
updatedOndatetime
phoneobject or null
emailstring or null
disabledOndatetime or null

Errors