Entity

Search entities

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

Search all entities with the given filters. If no filters are provided, all entities will be returned.

Query parameters

paymentMethods
optional boolean

If true, will include entity payment methods as part of the response

isCustomer
optional boolean

If true, only entities with a direct relationship to the requesting organization will be returned. If false or not provided, all entities will be returned.

foreignId
optional string

ID used to identify this entity in your system

status
optional enum
isPayee
optional boolean

If true, entities that are marked as payees will be returned. If false or not provided, entities that are marked as payees will not be returned.

isPayor
optional boolean

If true or not provided, entities that are marked as payors will be returned. If false, entities that are marked as payors will not be returned.

name
optional string

Filter entities by name. Partial matches are supported.

limit
optional integer

Number of entities to return. Limit can range between 1 and 100, and the default is 10.

startingAfter
optional string

The ID of the entity to start after. If not provided, the first page of entities will be returned.

Response

This endpoint return an object.
count
integer

Total number of entities for the given filters. This value is not limited by the limit parameter. It is provided so that you can determine how many pages of results are available.

hasMore
boolean

True if there are more entities available for the given filters.

data
list of objects
GET
/entity
curl -G https://api.mercoa.com/entity \
-H "Authorization: Bearer <token>" \
-d paymentMethods=true \
-d isCustomer=true
Response
{
"count": 0,
"hasMore": true,
"data": [
{
"acceptedTos": true,
"accountType": "business",
"createdAt": "2023-01-01T00:00:00Z",
"email": "string",
"id": "string",
"isCustomer": true,
"isPayee": true,
"isPayor": true,
"name": "string",
"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",
"updatedAt": "2023-01-01T00:00:00Z",
"emailTo": "string",
"emailToAlias": [
"string"
],
"foreignId": "string",
"paymentMethods": [
{
"type": "bankAccount",
"accountName": "string",
"accountNumber": "string",
"accountType": "CHECKING",
"bankName": "string",
"createdAt": "2023-01-01T00:00:00Z",
"id": "string",
"isDefaultDestination": true,
"isDefaultSource": true,
"routingNumber": "string",
"status": "NEW",
"supportedCurrencies": [
"AED"
],
"updatedAt": "2023-01-01T00:00:00Z",
"checkOptions": {
"enabled": true,
"initialCheckNumber": 0,
"routingNumberOverride": "string",
"accountNumberOverride": "string",
"signatoryName": "string",
"signatureImage": "string"
}
}
]
}
]
}