Add Compliance Information

curl --request PUT \
  --url https://api.dots.dev/api/v2/users/{user_id}/compliance \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '{
  "w9": {
    "entity_type": "individual",
    "business_name": "<string>",
    "first_name": "<string>",
    "last_name": "<string>",
    "date_of_birth": "2023-12-25",
    "tin": "<string>",
    "address": {
      "line_1": "<string>",
      "line_2": "<string>",
      "city": "<string>",
      "state": "<string>",
      "country": "<string>",
      "postcode": "<string>"
    }
  },
  "w8ben": {
    "name": "<string>",
    "citizenship_country": "<string>",
    "date_of_birth": "2023-12-25",
    "tin": "<string>",
    "foreign_tax_id": "<string>",
    "tax_treaty_country": "<string>",
    "tax_treaty_citation": "<string>",
    "tax_treaty_rate": 123,
    "tax_treaty_income_type": "interest1",
    "tax_treaty_explanation": "<string>",
    "address": {
      "line_1": "<string>",
      "line_2": "<string>",
      "city": "<string>",
      "state": "<string>",
      "country": "<string>",
      "postcode": "<string>"
    },
    "signature": {
      "consent": true,
      "name": "<string>",
      "email": "<string>"
    }
  }
}'

Authorizations

Authorization

string

headerrequired

Basic authentication header of the form Basic <encoded-value>, where <encoded-value> is the base64-encoded string username:password.

Path Parameters

user_id

string

required

Id of the user to fetch

Body

application/json

object

W-9 equivalent for users based in the United States.

w8ben

object

W8-BEN form for foreign payees.

w8ben.name

string

required

Full name of the person.

w8ben.citizenship_country

string

required

The two-letter ISO country code associated with the beneficial owner's citizenship.

w8ben.date_of_birth

string

required

Date of birth of the user.

w8ben.tin

string

required

SSN

w8ben.foreign_tax_id

string

The tax identification number associated with the beneficial owner's country of residence.

w8ben.tax_treaty_country

string

The two-letter ISO country code of the country for tax treaty purposes.

w8ben.tax_treaty_citation

string

The article and paragraph of the citation claimed for tax treaty purposes.

w8ben.tax_treaty_rate

number

The withholding rate claimed for tax treaty purposes. For example, a 15% rate would be represented as 0.15.

w8ben.tax_treaty_income_type

enum<string>

The type of income for tax treaty purposes. Valid values are - interest1 (Interest Paid by U.S. Obligors) - dividend6 (Dividends Paid by U.S. Corporations) - dividend7 (Dividends Qualifying for Direct Dividend Rate) - pension15 (Pensions and Annuities) - socialSecurity (Social Security) - equipment10 (Industrial Equipment) - knowhow10 (Know-How/Other Industrial Royalties) - patent10 (Patents) - film11 (Film & TV) - copyright12 (Copyrights)

Available options:

interest1,

dividend6,

dividend7,

pension15,

socialSecurity,

equipment10,

knowhow10,

patent10,

film11,

copyright12

w8ben.tax_treaty_explanation

string

An optional explanation for the tax treaty claimed.

w8ben.address

object

required

Address of the user or their business.

w8ben.signature

object

required

Signature of the user.

List all Users Add Payout Methods

curl --request PUT \
  --url https://api.dots.dev/api/v2/users/{user_id}/compliance \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '{
  "w9": {
    "entity_type": "individual",
    "business_name": "<string>",
    "first_name": "<string>",
    "last_name": "<string>",
    "date_of_birth": "2023-12-25",
    "tin": "<string>",
    "address": {
      "line_1": "<string>",
      "line_2": "<string>",
      "city": "<string>",
      "state": "<string>",
      "country": "<string>",
      "postcode": "<string>"
    }
  },
  "w8ben": {
    "name": "<string>",
    "citizenship_country": "<string>",
    "date_of_birth": "2023-12-25",
    "tin": "<string>",
    "foreign_tax_id": "<string>",
    "tax_treaty_country": "<string>",
    "tax_treaty_citation": "<string>",
    "tax_treaty_rate": 123,
    "tax_treaty_income_type": "interest1",
    "tax_treaty_explanation": "<string>",
    "address": {
      "line_1": "<string>",
      "line_2": "<string>",
      "city": "<string>",
      "state": "<string>",
      "country": "<string>",
      "postcode": "<string>"
    },
    "signature": {
      "consent": true,
      "name": "<string>",
      "email": "<string>"
    }
  }
}'