POST
/
v2
/
screening
/
send
curl --request POST \
  --url https://sandbox-api.getcove.co/v2/screening/send \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '{
  "flowId": "<string>",
  "email": "<string>",
  "phone": "<string>",
  "firstName": "<string>",
  "lastName": "<string>",
  "payer": "PAYER_UNSPECIFIED"
}'
{
  "userId": "<string>",
  "message": "<string>"
}

Authorizations

Authorization
string
header
required

API authentication token

Body

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

Response

200
application/json
A successful response.
userId
string
message
string