Skip to main content
POST
/
v2
/
screening
/
send
Error
A valid request URL is required to generate request examples
{
  "message": "<string>",
  "userId": "<string>",
  "screeningId": "<string>",
  "screeningLink": "<string>"
}

Documentation Index

Fetch the complete documentation index at: https://docs.cove.dev/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
Authorization
string
header
required

API authentication token

Body

application/json
​
flowId
string
​
email
string
​
phone
string
​
firstName
string
​
lastName
string
​
metadata
object
​
options
object
​
payer
enum<string>
default:PAYER_UNSPECIFIED
Available options:
PAYER_UNSPECIFIED,
PAYER_SELF,
PAYER_APPLICANT

Response

A successful response.

​
message
string
​
userId
string
​
screeningId
string
​
screeningLink
string