Create test taker
Enrolls a test taker under the project, storing your referenceId. Returns the created test taker including its projectEntryId, which you pass to POST …/test-link to get a magic link.
Authorizations
API key generated in the Portal (Workspace Settings → API Keys).
Path Parameters
Project Id. Obtain via GET /projects or from the project URL.
Body
The email address of the test taker.
The first name of the test taker.
100The last name of the test taker.
100The birth year of the test taker.
Your own external reference id for this test taker; echoed back on the completion webhook.
^[a-zA-Z0-9_\-.+@]{1,500}$Response
Created
Globally unique identifier of the created test taker.
Identifier of the test taker's project entry. Pass this as the id to POST .../test-link to obtain a magic link.
The test taker's email address. Null if not provided.
The test taker's first name. Null if not provided.
The test taker's last name. Null if not provided.
The test taker's year of birth. Null if not provided.
Your own identifier for this test taker, echoed back if one was supplied on creation. Null if none was set.