Generate Onboarding Link
Generate an onboarding link for the entity.
Path parameters
entityId
Entity ID or Entity ForeignID
Headers
Authorization
Bearer authentication of the form Bearer <token>, where token is your auth token.
Query parameters
type
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:
expiresIn
Expressed in seconds or a string describing a time span. The default is 24h.
connectedEntityId
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 returns a string.