Skip to main content
POST
/
api
/
v1
/
user
/
invite
Send invite
curl --request POST \
  --url https://api.hevn.finance/api/v1/user/invite \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "email": "jsmith@example.com"
}
'
{}

Authorizations

​
Authorization
string
header
default:Bearer <token>
required

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

Headers

​
x-api-key
string | null

Body

application/json

Request schema for sending an invite.

​
email
string<email>
required
​
flow
enum<string>
required

Invite flow types.

Available options:
kyb_manager,
employer,
team_member

Response

Successful Response

The response is of type Response Send Legacy User Invite Api V1 User Invite Post · object.