Get an entity

GET

/entities/:entity_id

Retrieve an entity by its ID.

Path parameters

entity_idstringRequired

A unique ID to specify the entity.

Headers

Auth

AuthorizationstringRequired

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

x-monite-versionstringRequired

Response

Successful Response

Individual

Organization

Errors

GET

1 curl https://api.sandbox.monite.com/v1/entities/ea837e28-509b-4b6a-a600-d54b6aa0b1f5 \
2      -H "x-monite-version: 2024-05-25" \
3      -H "Authorization: Bearer <token>"

1 {
2   "type": "organization",
3   "address": {
4     "city": "city",
5     "country": "AF",
6     "line1": "line1",
7     "postal_code": "postal_code",
8     "line2": "line2",
9     "state": "state"
10   },
11   "created_at": "2024-01-15T09:30:00Z",
12   "id": "string",
13   "organization": {
14     "legal_name": "legal_name",
15     "business_structure": "incorporated_partnership",
16     "directors_provided": true,
17     "executives_provided": true,
18     "legal_entity_id": "legal_entity_id",
19     "owners_provided": true,
20     "representative_provided": true
21   },
22   "status": "active",
23   "updated_at": "2024-01-15T09:30:00Z",
24   "email": "string",
25   "logo": {
26     "id": "id",
27     "created_at": "2024-01-15T09:30:00Z",
28     "file_type": "payables",
29     "md5": "31d1a2dd1ad3dfc39be849d70a68dac0",
30     "mimetype": "application/pdf",
31     "name": "invoice.pdf",
32     "region": "eu-central-1",
33     "size": 24381,
34     "url": "https://bucketname.s3.amazonaws.com/12345/67890.pdf",
35     "pages": [
36       {
37         "id": "id",
38         "mimetype": "image/png",
39         "number": 0,
40         "size": 21972,
41         "url": "https://bucket.s3.amazonaws.com/123/456.png"
42       }
43     ],
44     "previews": [
45       {
46         "height": 400,
47         "url": "https://bucketname.s3.amazonaws.com/1/2/3.png",
48         "width": 200
49       }
50     ]
51   },
52   "phone": "string",
53   "tax_id": "string",
54   "website": "string"
55 }

Update an entity

Up Next

1	curl https://api.sandbox.monite.com/v1/entities/ea837e28-509b-4b6a-a600-d54b6aa0b1f5 \
2	-H "x-monite-version: 2024-05-25" \
3	-H "Authorization: Bearer <token>"

1	{
2	"type": "organization",
3	"address": {
4	"city": "city",
5	"country": "AF",
6	"line1": "line1",
7	"postal_code": "postal_code",
8	"line2": "line2",
9	"state": "state"
10	},
11	"created_at": "2024-01-15T09:30:00Z",
12	"id": "string",
13	"organization": {
14	"legal_name": "legal_name",
15	"business_structure": "incorporated_partnership",
16	"directors_provided": true,
17	"executives_provided": true,
18	"legal_entity_id": "legal_entity_id",
19	"owners_provided": true,
20	"representative_provided": true
21	},
22	"status": "active",
23	"updated_at": "2024-01-15T09:30:00Z",
24	"email": "string",
25	"logo": {
26	"id": "id",
27	"created_at": "2024-01-15T09:30:00Z",
28	"file_type": "payables",
29	"md5": "31d1a2dd1ad3dfc39be849d70a68dac0",
30	"mimetype": "application/pdf",
31	"name": "invoice.pdf",
32	"region": "eu-central-1",
33	"size": 24381,
34	"url": "https://bucketname.s3.amazonaws.com/12345/67890.pdf",
35	"pages": [
36	{
37	"id": "id",
38	"mimetype": "image/png",
39	"number": 0,
40	"size": 21972,
41	"url": "https://bucket.s3.amazonaws.com/123/456.png"
42	}
43	],
44	"previews": [
45	{
46	"height": 400,
47	"url": "https://bucketname.s3.amazonaws.com/1/2/3.png",
48	"width": 200
49	}
50	]
51	},
52	"phone": "string",
53	"tax_id": "string",
54	"website": "string"
55	}