Entity

Generate Onboarding Link

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

Generate an onboarding link for the entity.

Path parameters

entityId
string

Query parameters

type
enum

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: PAYEEPAYOR
expiresIn
optional string

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

connectedEntityId
optional string

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.

Response

This endpoint return a string.
GET
/entity/:entityId/onboarding
curl -G https://api.mercoa.com/entity/:entityId/onboarding \
-H "Authorization: Bearer <token>" \
-d type=PAYEE \
-d expiresIn=string \
-d connectedEntityId=string
Response
"string"