Entity

Send Onboarding Email

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

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: PAYEEPAYOR
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.