Entity

Get entity

GET
https://api.mercoa.com/entity/:entityId

Path parameters

entityId
string

Response

This endpoint return 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
optional string

The ID used to identify this entity in your system

emailTo
optional string

Local-part/username of the email address to which to send invoices to be added to the Invoice Inbox.

emailToAlias
optional list of strings

Email inbox alias addresses. Used when forwarding emails to the emailTo address from an alias.

GET
/entity/:entityId
curl https://api.mercoa.com/entity/:entityId \
-H "Authorization: Bearer <token>"
Response
{
"id": "string",
"name": "string",
"email": "string",
"isCustomer": true,
"accountType": "business",
"profile": {
"business": {
"legalBusinessName": "string",
"taxIDProvided": true,
"email": "string",
"businessType": "soleProprietorship",
"phone": {
"countryCode": "string",
"number": "string"
},
"doingBusinessAs": "string",
"website": "string",
"description": "string",
"address": {
"addressLine1": "string",
"city": "string",
"stateOrProvince": "string",
"postalCode": "string",
"addressLine2": "string",
"country": "string"
},
"ownersProvided": true
},
"individual": {
"email": "string",
"name": {
"firstName": "string",
"lastName": "string",
"middleName": "string",
"suffix": "string"
},
"birthDateProvided": true,
"governmentIDProvided": true,
"phone": {
"countryCode": "string",
"number": "string"
},
"address": {
"addressLine1": "string",
"city": "string",
"stateOrProvince": "string",
"postalCode": "string",
"addressLine2": "string",
"country": "string"
}
}
},
"status": "unverified",
"acceptedTos": true,
"isPayor": true,
"isPayee": true,
"createdAt": "2023-01-01T00:00:00Z",
"updatedAt": "2023-01-01T00:00:00Z",
"foreignId": "string",
"emailTo": "string",
"emailToAlias": [
"string"
]
}