Send invite

Legacy mapping for team invites. Prefer POST /team/invite.

POST /api/v1/user/invite

Send invite

cURL

curl --request POST \
  --url https://api.hevn.finance/api/v1/user/invite \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "email": "[e-mail]"
}
'

import requests

url = "https://api.hevn.finance/api/v1/user/invite"

payload = { "email": "[e-mail]" }
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({email: '[e-mail]'})
};

fetch('https://api.hevn.finance/api/v1/user/invite', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

200

{}

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>"
    }
  ]
}

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

200

application/json

Successful Response

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