Fix a person's email or phone number, even after signing or submitting, so their identity link reaches them.
Use this endpoint when a person's email or phone number was wrong, for instance because their identity-verification link bounced. Send email, phone or both. Fields you leave out aren't changed.
Part of People and ownership. For how this fits into onboarding, see the guide: Signing the agreements: changing information after signing.
personRef is signer, control-person, or owner-<id> for a beneficial owner. You'll find each person's reference in their record and in Retrieve onboarding status.
What happens
- If the person's identity check isn't complete yet, the check is reset and a new verification link is sent to the corrected contact details.
- Contact details appear on the signed contract documents. If you change one after the documents are signed, the signature is voided and a new signature is requested (the contract's
requestReasonisRE_SIGN_REQUIRED). Sending the value that's already on file changes nothing and voids nothing.
When you can call this
While the onboarding is a DRAFT or UNDER_REVIEW. Once it's approved, declined or withdrawn, it returns 409.
Errors
| Status | Meaning |
|---|---|
400 | The phone number isn't a 10-digit number. |
401 | The API key is missing, malformed or expired. |
404 | The company wasn't found, or it has no such person. |
409 | The onboarding has been approved, declined or withdrawn. |
422 | The email isn't a valid email address. |
The contact details were corrected. The response body is empty.