How to work with the users API
user
is a representation of a person or entity in the Dots system. A user
can be created by a platform or by the user
themselves but can be connected to any platform.
The platform can add additional data to a user
such as an SSN and address for tax purposes and add bank accounts and other payment methods.
compliance.w9.tax_id_verification
field returned the GET /user/:id endpoint.
The possible statuses are:
unsubmitted
: The user’s TIN has not been submitted yet.pending
: The user’s TIN is pending verification.matched
: The user’s TIN was successfully verified and matched their name.mismatched
: The user’s TIN did not match their name.compliance.flags.ofac_status
field returned by the
GET /user/:id endpoint. The
possible statuses are:
unflagged
: The user is unflagged.id_verification_required
: The user must complete ID verification.in_review
: The user has completed ID verification and requires
a manual review.flagged
: The user is suspected of being a sanctioned individual.