---
title: "Send Invite"
method: POST
path: "/api/invites"
tags: ["invites"]
---

# Send Invite

`POST /api/invites`

Send Vouched Now invite.

## Request body

- Body2
  - `type` 'idv' | 'id' | 'selfie-verification' — idv - id with selfie verification, id - id only, selfie-verification - selfie verification only.
  - `email` string — Email address to send to.
  - `phone` string — 10 digit phone number. `US +1` `UK +44`
  - `contact` 'email' | 'phone' — Contact method to use.
  - `firstName` string — First Name.
  - `lastName` string — Last Name.
  - `templateEmail` string — The template to use for emails with variables $FIRST_NAME $LINK.
  - `titleEmail` string — The title of the email.
  - `templateText` string — The template to use for text messages with variables $FIRST_NAME $LINK.
  - `callbackURL` string — Upon the job's completion, Vouched will POST the job results to the defined [webhook](https://docs.vouched.id/docs/webhooks) .
  - `properties` ApijobsProperties[] — List of arbitrary customer supplied properties
    - `name` string — Name of the property
    - `value` string — Value of the property
  - `send` boolean — Send a message via the contact method.
  - `internalId` string — Application Internal Id.
  - `dob` string — The user's date of birth (MM/DD/YYYY) to verify.
  - `ial2CrossCheckId` string — Reference ID for NIST IAL2 compliance verification.
  - `enableCrossCheck` boolean — Used to enable/disable crosscheck.
  - `enableDarkWeb` boolean — Used to enable/disable darkweb.
  - `enableIPAddress` boolean — Used to enable/disable ip address search.
  - `enablePhysicalAddress` boolean — Used to enable/disable address search.

## Response `201`

Send an invite to use Vouched

## Other responses

- `400` — InvalidRequestError - The request is invalid.
- `401` — AuthenticationError - The request could not be authenticated.
- `404` — ConnectionError - A connection error occurred while communicating to the Vouched service.
- `429` — TooManyRequestsError - the Vouched service has throttled this request.
- `500` — UnknownSystemError - A unknown system error occurred.

---

[API](https://skmtc.net/vouched/apis/vouched-api.md) · [All operations](https://skmtc.net/vouched/apis/vouched-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/vouched/vouched-api/versions/e6b14826bf7f/schema)
