Sign in
Link Permissions

Record residency attestation

Attest whether the user is a citizen or resident of their current IP-derived jurisdiction.

post/api/link/v1/attestations

Headers

user-idstring required

User id of the user making the request.

Request body

countrystring required

ISO 3166-1 alpha-3 country code (e.g. USA).

The route-facing codec stays a plain string so OpenAPI schema generation can represent it. The service enforces the alpha-3 shape and known-country membership before recording the attestation.

subdivisionstring

Bare ISO 3166-2 subdivision code (e.g. NY) of the jurisdiction the user is attesting for. Must match the request's IP-derived subdivision; omit only for country-level jurisdictions.

isRestrictedIndividualboolean required

The user's answer to the "Restricted Individual" question for the jurisdiction.

Response

OK

Changes