Entity

Get entity

GET

Path parameters

entityIdstringRequired

Response

This endpoint returns an object
id
string
name
string
email
string
isCustomer
boolean
True if this entity has a direct relationship with your organization.
accountType
enum
Allowed values: businessindividual
profile
object
status
enum
acceptedTos
boolean
True if this entity has accepted the terms of service.
isPayor
boolean
True if this entity can pay invoices.
isPayee
boolean
True if this entity can receive payments.
createdAt
datetime
updatedAt
datetime
foreignId
stringOptional
The ID used to identify this entity in your system
emailTo
stringOptional
Local-part/username of the email address to which to send invoices to be added to the Invoice Inbox.
emailToAlias
list of stringsOptional
Email inbox alias addresses. Used when forwarding emails to the emailTo address from an alias.
GET
1curl https://api.mercoa.com/entity/:entityId \
2     -H "Authorization: Bearer <token>"
200
Retrieved
1{
2  "id": "string",
3  "name": "string",
4  "email": "string",
5  "isCustomer": true,
6  "accountType": "business",
7  "profile": {
8    "business": {
9      "legalBusinessName": "string",
10      "taxIDProvided": true,
11      "email": "string",
12      "businessType": "soleProprietorship",
13      "phone": {
14        "countryCode": "string",
15        "number": "string"
16      },
17      "doingBusinessAs": "string",
18      "website": "string",
19      "description": "string",
20      "address": {
21        "addressLine1": "string",
22        "city": "string",
23        "stateOrProvince": "string",
24        "postalCode": "string",
25        "addressLine2": "string",
26        "country": "string"
27      },
28      "ownersProvided": true
29    },
30    "individual": {
31      "name": {
32        "firstName": "string",
33        "lastName": "string",
34        "middleName": "string",
35        "suffix": "string"
36      },
37      "birthDateProvided": true,
38      "governmentIDProvided": true,
39      "email": "string",
40      "phone": {
41        "countryCode": "string",
42        "number": "string"
43      },
44      "address": {
45        "addressLine1": "string",
46        "city": "string",
47        "stateOrProvince": "string",
48        "postalCode": "string",
49        "addressLine2": "string",
50        "country": "string"
51      }
52    }
53  },
54  "status": "unverified",
55  "acceptedTos": true,
56  "isPayor": true,
57  "isPayee": true,
58  "createdAt": "2023-01-01T00:00:00Z",
59  "updatedAt": "2023-01-01T00:00:00Z",
60  "foreignId": "string",
61  "emailTo": "string",
62  "emailToAlias": [
63    "string"
64  ]
65}
Built with