Update

POST

Path parameters

entityIdstringRequired

Entity ID or Entity ForeignID

representativeIdstringRequired

Request

This endpoint expects an object.

nameobjectOptional

phoneobjectOptional

emailstringOptional

addressobjectOptional

birthDateobjectOptional

governmentIDobjectOptional

responsibilitiesobjectOptional

Response

This endpoint returns an object.

idstring

nameobject

addressobject

birthDateProvidedboolean

governmentIDProvidedboolean

responsibilitiesobject

createdOndatetime

updatedOndatetime

phoneobjectOptional

emailstringOptional

disabledOndatetimeOptional

POST

1 curl -X POST https://api.mercoa.com/entity/ent_8545a84e-a45f-41bf-bdf1-33b42a55812c/representative/rep_7df2974a-4069-454c-912f-7e58ebe030fb \
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   "phone": {
12     "countryCode": "1",
13     "number": "4155551234"
14   },
15   "email": "john.doe@acme.com",
16   "address": {
17     "addressLine1": "123 Main St",
18     "city": "San Francisco",
19     "stateOrProvince": "CA",
20     "postalCode": "94105",
21     "addressLine2": "Unit 1",
22     "country": "US"
23   },
24   "birthDate": {
25     "day": "1",
26     "month": "1",
27     "year": "1980"
28   },
29   "governmentID": {
30     "ssn": "123-45-6789"
31   },
32   "responsibilities": {
33     "isController": true,
34     "isOwner": true,
35     "ownershipPercentage": 40
36   }
37 }'

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 }

Delete

Up Next

Built with

1	curl -X POST https://api.mercoa.com/entity/ent_8545a84e-a45f-41bf-bdf1-33b42a55812c/representative/rep_7df2974a-4069-454c-912f-7e58ebe030fb \
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	"phone": {
12	"countryCode": "1",
13	"number": "4155551234"
14	},
15	"email": "john.doe@acme.com",
16	"address": {
17	"addressLine1": "123 Main St",
18	"city": "San Francisco",
19	"stateOrProvince": "CA",
20	"postalCode": "94105",
21	"addressLine2": "Unit 1",
22	"country": "US"
23	},
24	"birthDate": {
25	"day": "1",
26	"month": "1",
27	"year": "1980"
28	},
29	"governmentID": {
30	"ssn": "123-45-6789"
31	},
32	"responsibilities": {
33	"isController": true,
34	"isOwner": true,
35	"ownershipPercentage": 40
36	}
37	}'

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	}