Sign inBook a demo
HomeGuidesAPI ReferenceGlossary
HomeGuidesAPI ReferenceGlossary
  • API Reference
Logo
Sign inBook a demo
API ReferenceEntity

Send Onboarding Email

POST
https://api.mercoa.com/entity/:entityId/onboarding
POST
/entity/:entityId/onboarding
1curl -X POST "https://api.mercoa.com/entity/entityId/onboarding?type=PAYEE" \
2     -H "Authorization: Bearer <token>"
Try it
Send an email with a onboarding link to the entity. The email will be sent to the email address associated with the entity.
Was this page helpful?
Previous

Events

Next
Built with
Events
Send an email with a onboarding link to the entity. The email will be sent to the email address associated with the entity.

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

typeenumRequired
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.
Allowed values:
Entity ID or Entity ForeignID
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.

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

expiresInstringOptional
Expressed in seconds or a string describing a time span. The default is 7 days.
connectedEntityIdstringOptional
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.
redirectToPortalbooleanOptional
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.
vendorPortalOptionsobjectOptional
The options for the vendor portal.

Errors

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.