Create a verification link

POST

/business/links

Uses one verification credit. The url is only returned here and on resend: IDfier stores only a hash of it.

Authorization

clientIdclientSecret

headerclientid<token>

headerclientsecret<token>

Request Body

application/json

body

recipientName?string

Shown on the link page and in the email

Lengthlength <= 200

recipientEmail?string

IDfier emails the link to it, unless sendEmail is false

Formatemail

message?string

A message to the customer

Lengthlength <= 1000

scopes?array<string>

What to verify; defaults to all your scopes. Must be among your scopes. Any age check (ageOverN, ageBetween{min}And{max}) is allowed if you have age, dateOfBirth or an age scope.

expiresInDays?integer

Range1 <= value <= 30

Default7

sendEmail?boolean

Defaulttrue

createdBy?string

Your own note of who created it

Response Body

The link

application/json

response

status?Success

100 on success

data?

Example Request

curl -X POST 'https://api.idfier.com/api/v3/business/links' \
  -H 'Content-Type: application/json' \
  -d '{}'

Example Request

curl -X POST 'https://api.idfier.com/api/v3/business/links' \  -H 'Content-Type: application/json' \  -d '{}'

Example ResponseSchema

{
  "status": 100,
  "data": {
    "id": "string",
    "url": "http://example.com",
    "expiresAt": "2019-08-24T14:15:22Z",
    "emailSent": true
  }
}

{  "status": 100,  "data": {    "id": "string",    "url": "http://example.com",    "expiresAt": "2019-08-24T14:15:22Z",    "emailSent": true  }}

AuthorizationCopy Anchor Link

Request BodyCopy Anchor Link

Response BodyCopy Anchor Link

Authorization

Request Body

Response Body