GEgetcove
Screening V2

Send the screening link to the applicant

Changed on

Send the screening link

post/v2/screening/send

Request

  • Base URL
    / (relative, and the document was published on a file host, not at the API’s origin)
  • Auth
    API key in header Authorization

Request body

flowIdstring
emailstring
phonestring
firstNamestring
lastNamestring
metadataobject
payer'PAYER_UNSPECIFIED' | 'PAYER_SELF' | 'PAYER_APPLICANT'

Response

A successful response.

messagestring
userIdstring
screeningIdstring
screeningLinkstring

Changes

  • d073d48df6b1Revision changes
    • info

      api tag Screening V2 added

    • info

      api tag Screening removed

    • info

      added the new optional request property

  • b8251b9b3893Revision changes
    • info

      api tag Screening added

    • info

      api tag ScreeningV2 removed

    • info

      added the new optional request property

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status