entity

Create entity

post/entity

Request

  • Base URL: https://api.mercoa.com
  • URL: https://api.mercoa.com/entity
  • Auth: HTTP bearer

Request body

OR

Response

Response with status 200

idstring required
namestring required
emailstring required
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.

emailToAliasstring[]

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

isCustomerboolean required

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

accountType'business' | 'individual' required
logostring

URL for the entity logo

status'unverified' | 'pending' | 'resubmit' | 'review' | 'verified' | 'failed' required
oatfiStatusstring

The OatFi status of this entity

oatfiUnderwritingResponseobject

The OatFi underwriting response of this entity

acceptedTosboolean required

True if this entity has accepted the terms of service.

isPayorboolean required

True if this entity can pay invoices.

isPayeeboolean required

True if this entity can receive payments.

isNetworkPayorboolean required

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 required

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.

metadataobject

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

createdAtstring date-time required
updatedAtstring date-time required

Changes

No recorded changes to this operation across all 1 revision of this API.