Skip to main content
POST
Create test taker

Authorizations

x-api-key
string
header
required

API key generated in the Portal (Workspace Settings → API Keys).

Path Parameters

projectId
string<uuid>
required

Project Id. Obtain via GET /projects or from the project URL.

Body

email
string
required

The email address of the test taker.

firstName
null | string

The first name of the test taker.

Maximum string length: 100
lastName
null | string

The last name of the test taker.

Maximum string length: 100
birthYear

The birth year of the test taker.

referenceId
null | string

Your own external reference id for this test taker; echoed back on the completion webhook.

Pattern: ^[a-zA-Z0-9_\-.+@]{1,500}$

Response

Created

id
string<uuid>

Globally unique identifier of the created test taker.

projectEntryId

Identifier of the test taker's project entry. Pass this as the id to POST .../test-link to obtain a magic link.

email
null | string

The test taker's email address. Null if not provided.

firstName
null | string

The test taker's first name. Null if not provided.

lastName
null | string

The test taker's last name. Null if not provided.

birthYear

The test taker's year of birth. Null if not provided.

referenceId
null | string

Your own identifier for this test taker, echoed back if one was supplied on creation. Null if none was set.