Skip to main content

​
Authentication

  • Send header x-api-key: <your key> from Portal → Workspace Settings → API Keys.
  • Without the key, the playground returns 401 “API key required”.

​
Find your projectId

Open the List projects playground and copy the id of the project you want to work with.

​
Result status values

The result field on test taker and result responses takes one of the values listed in the List test takers playground.

​
Linking results to your own system

Two optional fields let you connect Neurapulse tests to records in your own platform (such as an Impirica platform product):
  • referenceId — your own identifier for a test taker (for example an employee number or subject ID). Store it when you enrol the test taker, and it is returned alongside their result so you can match it back to your record. See Reference IDs.
  • redirectUri — a page the test taker is returned to after they finish, passed when you call Get test link. It only takes effect if the URL is on your workspace’s allowlist. See Redirect URIs.
For the full round trip, see Linking with the Impirica Platform.