Get entity

GET

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

GET

/entity/:entityId

$ curl https://api.mercoa.com/entity/ent_a0f6ea94-0761-4a5e-a416-3c453cb7eced \
>      -H "Authorization: Bearer <token>"

1 {
2   "id": "ent_8545a84e-a45f-41bf-bdf1-33b42a55812c",
3   "name": "Acme Inc.",
4   "email": "customer@acme.com",
5   "isCustomer": true,
6   "accountType": "business",
7   "profile": {
8     "business": {
9       "legalBusinessName": "Acme Inc.",
10       "taxIDProvided": true,
11       "email": "customer@acme.com",
12       "businessType": "llc",
13       "phone": {
14         "countryCode": "1",
15         "number": "4155551234"
16       },
17       "address": {
18         "addressLine1": "123 Main St",
19         "city": "San Francisco",
20         "stateOrProvince": "CA",
21         "postalCode": "94105",
22         "addressLine2": "Unit 1",
23         "country": "US"
24       },
25       "ownersProvided": true,
26       "taxId": {
27         "ein": {
28           "number": "12-3456789"
29         }
30       }
31     }
32   },
33   "status": "verified",
34   "acceptedTos": true,
35   "isPayor": true,
36   "isPayee": false,
37   "isNetworkPayor": false,
38   "isNetworkPayee": false,
39   "createdAt": "2024-01-01T00:00:00Z",
40   "updatedAt": "2024-01-02T00:00:00Z",
41   "foreignId": "MY-DB-ID-12345"
42 }

curl https://api.mercoa.com/entity/ent_a0f6ea94-0761-4a5e-a416-3c453cb7eced \
     -H "Authorization: Bearer <token>"

{
  "id": "ent_8545a84e-a45f-41bf-bdf1-33b42a55812c",
  "name": "Acme Inc.",
  "email": "customer@acme.com",
  "isCustomer": true,
  "accountType": "business",
  "profile": {
    "business": {
      "legalBusinessName": "Acme Inc.",
      "taxIDProvided": true,
      "email": "customer@acme.com",
      "businessType": "llc",
      "phone": {
        "countryCode": "1",
        "number": "4155551234"
      },
      "address": {
        "addressLine1": "123 Main St",
        "city": "San Francisco",
        "stateOrProvince": "CA",
        "postalCode": "94105",
        "addressLine2": "Unit 1",
        "country": "US"
      },
      "ownersProvided": true,
      "taxId": {
        "ein": {
          "number": "12-3456789"
        }
      }
    }
  },
  "status": "verified",
  "acceptedTos": true,
  "isPayor": true,
  "isPayee": false,
  "isNetworkPayor": false,
  "isNetworkPayee": false,
  "createdAt": "2024-01-01T00:00:00Z",
  "updatedAt": "2024-01-02T00:00:00Z",
  "foreignId": "MY-DB-ID-12345"
}

Authentication

AuthorizationBearer

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

Path parameters

entityIdstringRequired

Entity ID or Entity ForeignID

Query parameters

returnMetadatastringOptional

Return simple key/value metadata for the specified keys for the entities. For more complex metadata, use the Metadata API.

Response

This endpoint returns an object.

idstring

namestring

emailstring

isCustomerboolean

True if this entity has a direct relationship with your organization.

accountTypeenum

Allowed values:

profileobject

statusenum

acceptedTosboolean

True if this entity has accepted the terms of service.

isPayorboolean

True if this entity can pay invoices.

isPayeeboolean

True if this entity can receive payments.

isNetworkPayorboolean

True if this entity is available as a payor to any entity on your platform. Otherwise this entity will only be available as a payor to entities that have a direct relationship with this entity.

isNetworkPayeeboolean

True if this entity is available as a payee to any entity on your platform. Otherwise this entity will only be available as a payee to entities that have a direct relationship with this entity.

createdAtdatetime

updatedAtdatetime

foreignIdstring

The ID used to identify this entity in your system

emailTostring

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

emailToAliaslist of strings

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

logostring

URL for the entity logo

oatfiStatusstring

The OatFi status of this entity

oatfiUnderwritingResponsemap from strings to strings

The OatFi underwriting response of this entity

metadatamap from strings to strings

Simple key/value metadata associated with this entity. For more complex metadata, use the Metadata API.

Errors

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

409

Conflict

500

Internal Server Error

501

Unimplemented

$	curl https://api.mercoa.com/entity/ent_a0f6ea94-0761-4a5e-a416-3c453cb7eced \
>	-H "Authorization: Bearer <token>"

1	{
2	"id": "ent_8545a84e-a45f-41bf-bdf1-33b42a55812c",
3	"name": "Acme Inc.",
4	"email": "customer@acme.com",
5	"isCustomer": true,
6	"accountType": "business",
7	"profile": {
8	"business": {
9	"legalBusinessName": "Acme Inc.",
10	"taxIDProvided": true,
11	"email": "customer@acme.com",
12	"businessType": "llc",
13	"phone": {
14	"countryCode": "1",
15	"number": "4155551234"
16	},
17	"address": {
18	"addressLine1": "123 Main St",
19	"city": "San Francisco",
20	"stateOrProvince": "CA",
21	"postalCode": "94105",
22	"addressLine2": "Unit 1",
23	"country": "US"
24	},
25	"ownersProvided": true,
26	"taxId": {
27	"ein": {
28	"number": "12-3456789"
29	}
30	}
31	}
32	},
33	"status": "verified",
34	"acceptedTos": true,
35	"isPayor": true,
36	"isPayee": false,
37	"isNetworkPayor": false,
38	"isNetworkPayee": false,
39	"createdAt": "2024-01-01T00:00:00Z",
40	"updatedAt": "2024-01-02T00:00:00Z",
41	"foreignId": "MY-DB-ID-12345"
42	}