Contacts

Confirm contact email verification

Submits the 6-digit code received by email. Returns the matching contact records if the code is valid, not expired, and has not already been used.

After 5 consecutive failed attempts the verification is permanently invalidated. The caller must re-initiate a new verification to try again.

post/api/contacts/verify-email/{requestId}/confirm

Request

Base URL
https://core-api.getaptly.com
Auth
- API key in header x-token
- or API key in header Authorization
TypeScript
https://skmtc.dev/getaptly/apis/aptly-api/docs/api/contacts/verify-email/:requestId/confirm/post.ts
A function with typed inputs. Its response is checked against the schema.

requestIdstring required

The requestId returned by the initiate endpoint.

codestring required

The 6-digit verification code sent to the email address.

Code accepted — returns verified status and matching contacts.

verifiedboolean

{
  "verified": true
}

No recorded changes to this operation across all 1 revision of this API.