Get All

GET

Get representatives for an entity

Path parameters

entityIdstringRequired

Entity ID or Entity ForeignID

Response

This endpoint returns a list of objects.

idstring

nameobject

addressobject

birthDateProvidedboolean

governmentIDProvidedboolean

responsibilitiesobject

createdOndatetime

updatedOndatetime

phoneobjectOptional

emailstringOptional

disabledOndatetimeOptional

GET

1 curl https://api.mercoa.com/entity/ent_8545a84e-a45f-41bf-bdf1-33b42a55812c/representatives \
2      -H "Authorization: Bearer <token>"

200BusinessPayorRepresentatives

1 [
2   {
3     "id": "rep_958c4ffb-dc06-494c-a0e0-1b4946c6bb0f",
4     "name": {
5       "firstName": "Jane",
6       "lastName": "Smith"
7     },
8     "address": {
9       "addressLine1": "456 Main St",
10       "city": "New York",
11       "stateOrProvince": "NY",
12       "postalCode": "10001",
13       "country": "US"
14     },
15     "birthDateProvided": true,
16     "governmentIDProvided": true,
17     "responsibilities": {
18       "isOwner": true,
19       "ownershipPercentage": 40
20     },
21     "createdOn": "2024-01-01T00:00:00Z",
22     "updatedOn": "2024-01-01T00:00:00Z",
23     "phone": {
24       "countryCode": "1",
25       "number": "2075551234"
26     },
27     "email": "jane.smith@acme.com",
28     "disabledOn": null
29   },
30   {
31     "id": "rep_7df2974a-4069-454c-912f-7e58ebe030fb",
32     "name": {
33       "firstName": "John",
34       "lastName": "Adams",
35       "middleName": "Quincy",
36       "suffix": "Jr."
37     },
38     "address": {
39       "addressLine1": "123 Main St",
40       "city": "San Francisco",
41       "stateOrProvince": "CA",
42       "postalCode": "94105",
43       "addressLine2": "Unit 1",
44       "country": "US"
45     },
46     "birthDateProvided": true,
47     "governmentIDProvided": true,
48     "responsibilities": {
49       "isController": true,
50       "isOwner": true,
51       "ownershipPercentage": 40
52     },
53     "createdOn": "2024-01-01T00:00:00Z",
54     "updatedOn": "2024-01-01T00:00:00Z",
55     "phone": {
56       "countryCode": "1",
57       "number": "4155551234"
58     },
59     "email": "john.doe@acme.com",
60     "disabledOn": null
61   }
62 ]

Create

Up Next

Built with

1	curl https://api.mercoa.com/entity/ent_8545a84e-a45f-41bf-bdf1-33b42a55812c/representatives \
2	-H "Authorization: Bearer <token>"

1	[
2	{
3	"id": "rep_958c4ffb-dc06-494c-a0e0-1b4946c6bb0f",
4	"name": {
5	"firstName": "Jane",
6	"lastName": "Smith"
7	},
8	"address": {
9	"addressLine1": "456 Main St",
10	"city": "New York",
11	"stateOrProvince": "NY",
12	"postalCode": "10001",
13	"country": "US"
14	},
15	"birthDateProvided": true,
16	"governmentIDProvided": true,
17	"responsibilities": {
18	"isOwner": true,
19	"ownershipPercentage": 40
20	},
21	"createdOn": "2024-01-01T00:00:00Z",
22	"updatedOn": "2024-01-01T00:00:00Z",
23	"phone": {
24	"countryCode": "1",
25	"number": "2075551234"
26	},
27	"email": "jane.smith@acme.com",
28	"disabledOn": null
29	},
30	{
31	"id": "rep_7df2974a-4069-454c-912f-7e58ebe030fb",
32	"name": {
33	"firstName": "John",
34	"lastName": "Adams",
35	"middleName": "Quincy",
36	"suffix": "Jr."
37	},
38	"address": {
39	"addressLine1": "123 Main St",
40	"city": "San Francisco",
41	"stateOrProvince": "CA",
42	"postalCode": "94105",
43	"addressLine2": "Unit 1",
44	"country": "US"
45	},
46	"birthDateProvided": true,
47	"governmentIDProvided": true,
48	"responsibilities": {
49	"isController": true,
50	"isOwner": true,
51	"ownershipPercentage": 40
52	},
53	"createdOn": "2024-01-01T00:00:00Z",
54	"updatedOn": "2024-01-01T00:00:00Z",
55	"phone": {
56	"countryCode": "1",
57	"number": "4155551234"
58	},
59	"email": "john.doe@acme.com",
60	"disabledOn": null
61	}
62	]