API ReferenceEntity

Generate Onboarding Link

Generate an onboarding link for the entity.

Path parameters

entityIdstringRequired

Entity ID or Entity ForeignID

Headers

AuthorizationstringRequired

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

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:
expiresInstringOptional

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

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.

Response

This endpoint returns a string.

Errors