/
OF
office-of-national-statistics
Search skmtc…
⌘K
Docs
Sign in
Docs
History
Schema
Generate
Retired
Filter operations
businesses
11
enrolments
1
info
1
misc
11
respondents
29
get
/respondents/email
Get a respondent by email
put
/respondents/email
Change the email address of a respondent
delete
/respondents/{email}
Mark a respondent for deletion by email
get
/tokens/verify/{token}
Verify a token
put
/respondents/change_password
Change the password of a respondent
put
/respondents/reset_password
Change respondent password using one-time token
post
/respondents/request_password_change
Request a password change email
get
/respondents
Get a respondent by query parameters
post
/respondents
Create a respondent
put
/emailverification/{token}
Verify an email address
post
/resend-verification-email/{party-uuid}
Resend the verification email
post
/resend-account-email-change-notification/{party_uuid}
Resend the email change notification email
post
/resend-account-email-change-expired-token/{token}
Resend the "expired token" email for change email
post
/resend-verification-email-expired-token/{token}
Resend the "expired token" email for verification email
post
/resend-password-email-expired-token/{token}
Resend the "expired token" email for password change
post
/respondents/add_survey
Enrol a respondent on a new survey
put
/respondents/change_enrolment_status
Change the enrolment status of a respondent
patch
/respondents/disable-user-enrolments
Disable all enrolments for a respondent
get
/respondents/id/{id}
Get a respondent by ID
put
/respondents/id/{id}
Update a respondent's details
get
/respondents/party_id/{party_id}
Get a respondent by party_id
get
/respondents/survey_id/{survey_id}/business_id/{business_id}
Get respondents by survey and business
get
/respondents/claim
Verifies a respondent has a claim on a specific business
put
/respondents/edit-account-status/{party_id}
Edit the account status of a respondent
post
/pending-survey-respondent
Create a respondent for share/transfer survey
get
/respondents/{respondent_id}/password-verification-token
Get the password verification token for a respondent
post
/respondents/{respondent_id}/password-verification-token
Set the password verification token for a respondent
get
/respondents/{respondent_id}/password-reset-counter
Get the password reset counter for a respondent
delete
/respondents/{respondent_id}/password-reset-counter
Reset the password reset counter for a respondent
respondents
Copy
Copy Markdown
Copy Markdown
Copying…
Copied
Copy failed
Changes to Verifies a respondent has a claim on a specific business
get
/respondents/claim
Sep 25, 2024
93b393164204
Revision changes
breaking
added the new required
query
request parameter
survey_id