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>"

200Retrieved

1 {
2   "type": "individual",
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": "id",
13   "individual": {
14     "first_name": "first_name",
15     "last_name": "last_name",
16     "date_of_birth": "date_of_birth",
17     "id_number": "id_number",
18     "ssn_last_4": "ssn_last_4",
19     "title": "title"
20   },
21   "status": "active",
22   "updated_at": "2024-01-15T09:30:00Z",
23   "email": "email",
24   "logo": {
25     "id": "id",
26     "created_at": "2024-01-15T09:30:00Z",
27     "file_type": "payables",
28     "md5": "31d1a2dd1ad3dfc39be849d70a68dac0",
29     "mimetype": "application/pdf",
30     "name": "invoice.pdf",
31     "region": "eu-central-1",
32     "size": 24381,
33     "url": "https://bucketname.s3.amazonaws.com/12345/67890.pdf",
34     "pages": [
35       {
36         "id": "id",
37         "mimetype": "image/png",
38         "number": 0,
39         "size": 21972,
40         "url": "https://bucket.s3.amazonaws.com/123/456.png"
41       }
42     ],
43     "previews": [
44       {
45         "height": 400,
46         "url": "https://bucketname.s3.amazonaws.com/1/2/3.png",
47         "width": 200
48       }
49     ]
50   },
51   "phone": "phone",
52   "tax_id": "tax_id",
53   "website": "website"
54 }

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": "individual",
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": "id",
13	"individual": {
14	"first_name": "first_name",
15	"last_name": "last_name",
16	"date_of_birth": "date_of_birth",
17	"id_number": "id_number",
18	"ssn_last_4": "ssn_last_4",
19	"title": "title"
20	},
21	"status": "active",
22	"updated_at": "2024-01-15T09:30:00Z",
23	"email": "email",
24	"logo": {
25	"id": "id",
26	"created_at": "2024-01-15T09:30:00Z",
27	"file_type": "payables",
28	"md5": "31d1a2dd1ad3dfc39be849d70a68dac0",
29	"mimetype": "application/pdf",
30	"name": "invoice.pdf",
31	"region": "eu-central-1",
32	"size": 24381,
33	"url": "https://bucketname.s3.amazonaws.com/12345/67890.pdf",
34	"pages": [
35	{
36	"id": "id",
37	"mimetype": "image/png",
38	"number": 0,
39	"size": 21972,
40	"url": "https://bucket.s3.amazonaws.com/123/456.png"
41	}
42	],
43	"previews": [
44	{
45	"height": 400,
46	"url": "https://bucketname.s3.amazonaws.com/1/2/3.png",
47	"width": 200
48	}
49	]
50	},
51	"phone": "phone",
52	"tax_id": "tax_id",
53	"website": "website"
54	}