v9

latestOpenAPI 3.0.0raw.githubusercontent.com2025-12-15521353.8 KB

respondents

Create a respondent

Create a respondent and set up pending enrolment before account verification

post/respondents

Request body

emailAddressstring email

The email address of the respondent

firstNamestring

The first name of the respondent

lastNamestring

The last name of the respondent

passwordstring

The password of the respondent

telephonestring

The telephone number of the respondent

enrolmentCodestring

The enrolment code the respondent is using

Response

The respondent has been created

idstring uuid

sampleUnitTypestring

pendingEmailAddressstring email

firstNamestring

lastNamestring

telephonestring

status'CREATED' | 'ACTIVE' | 'SUSPENDED'

markForDeletionboolean

passwordVerificationTokenstring

passwordResetCounterinteger

Example response

{
  "id": "91e0bb4f-ffad-404c-af1b-01c87037119c",
  "sampleUnitType": "BI",
  "pendingEmailAddress": "example@ons.gov.uk",
  "firstName": "Jane",
  "lastName": "Doe",
  "associations": [
    {
      "partyId": "91e0bb4f-ffad-404c-af1b-01c87037119c",
      "enrolments": [
        {
          "surveyId": "91e0bb4f-ffad-404c-af1b-01c87037119c"
        }
      ]
    }
  ]
}