entity

Generate Onboarding Link

Generate an onboarding link for the entity.

get/entity/{entityId}/onboarding

Request

  • Base URL: https://api.mercoa.com
  • URL: https://api.mercoa.com/entity/{entityId}/onboarding
  • Auth: HTTP bearer

Path parameters

entityIdstring required

Entity ID or Entity ForeignID

Query parameters

type'PAYEE' | 'PAYOR' required

The type of onboarding link to generate. If not provided, the default is payee. The onboarding options are determined by your organization's onboarding configuration.

expiresInstring

Expressed in seconds or a string describing a time span. The default is 24h.

connectedEntityIdstring

The ID of the entity to connect to. If onboarding a payee, this should be the payor entity ID. If onboarding a payor, this should be the payee entity ID. If no connected entity ID is provided, the onboarding link will be for a standalone entity.

redirectToPortalboolean

If true, the onboarding link will redirect to the vendor/customer portal if the entity is already onboarded. If false, the onboarding link will not redirect to the portal. The default is false.

tabsEntityTypesVendorPortalTab[]

The tabs to display in the vendor portal. If not provided, all tabs will be displayed.

defaultTab'HOME' | 'PROFILE' | 'INVOICES' | 'PAYMENT_METHODS' | 'VENDOR_CREDITS'
welcomeMessagestring

The welcome message to display in the vendor portal. If not provided, no welcome message will be displayed.

The options for the vendor portal.

Response

Response with status 200

string required

Changes

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