users
transfers
payout-links
payout-batches
payments
payment-intents
payment-customers
checkout-sessions
accounts-payable
- GETList all vendors
- POSTCreate a vendor
- GETGet vendor details
- DELDelete a vendor
- GETList all payment methods for a vendor
- POSTCreate a payment method for a vendor
- GETGet vendor payment method details
- DELDelete a vendor payment method
- GETList all payables
- POSTCreate a payable
- POSTCreate a payable from a file
- GETGet payable details
- PATCHUpdate a payable
- POSTUpload file to the payable
- DELDelete file from the payable
- POSTCancel a payable
- POSTSubmit a payable for approval
- POSTApprove a payable
- POSTReject a payable
- POSTPay a payable
- GETList all approval policies
- POSTCreate an approval policy
- DELDelete an approval policy
- PATCHUpdate priority of an approval policy
- GETList all approvers for api app
apps
- GETList all Apps
- POSTCreate an App
- GETRetrieve an App
- GETRetrieve an App's Compliance Information
- PUTUpdate an App's Compliance Information
- GETGet App ACH Account
- PUTAdd App ACH Account
- POSTDeposit Funds into App Wallet
- POSTWithdraw Funds From App Wallet
- POSTRefresh compliance flow
- POSTUpdate an application's settings
payment-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",
"date_of_birth": "2023-12-25",
"tin": "<string>",
"address": {
"line_1": "<string>",
"city": "<string>",
"state": "<string>",
"country": "<string>",
"postcode": "<string>",
"line_2": "<string>"
},
"business_name": "<string>",
"first_name": "<string>",
"last_name": "<string>"
},
"w8ben": {
"name": "<string>",
"citizenship_country": "<string>",
"date_of_birth": "2023-12-25",
"address": {
"line_1": "<string>",
"city": "<string>",
"country": "<string>",
"postcode": "<string>",
"line_2": "<string>",
"state": "<string>"
},
"signature": {
"consent": true,
"name": "<string>",
"email": "<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>"
}
}
'{}Submit Compliance Information
Add Compliance information to a user.
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",
"date_of_birth": "2023-12-25",
"tin": "<string>",
"address": {
"line_1": "<string>",
"city": "<string>",
"state": "<string>",
"country": "<string>",
"postcode": "<string>",
"line_2": "<string>"
},
"business_name": "<string>",
"first_name": "<string>",
"last_name": "<string>"
},
"w8ben": {
"name": "<string>",
"citizenship_country": "<string>",
"date_of_birth": "2023-12-25",
"address": {
"line_1": "<string>",
"city": "<string>",
"country": "<string>",
"postcode": "<string>",
"line_2": "<string>",
"state": "<string>"
},
"signature": {
"consent": true,
"name": "<string>",
"email": "<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>"
}
}
'{}Authorizations
Basic authentication header of the form Basic <encoded-value>, where <encoded-value> is the base64-encoded string username:password.
Path Parameters
Id of the user to fetch
Body
W-9 equivalent for users based in the United States.
Show child attributes
Show child attributes
Type of entity filling out the W-9, business or individual.
individual, business Required if entity_type is individual.
SSN if entity_type is individual. EIN if entity_type is business.
9Address of the user or their business.
Legal bussiness name. Required if entity_type is business.
W8-BEN form for foreign payees.
Show child attributes
Show child attributes
Full name of the person.
The two-letter ISO country code associated with the beneficial owner's citizenship.
Date of birth of the user.
Address of the user or their business.
Signature of the user.
Show child attributes
Show child attributes
The tax identification number associated with the beneficial owner's country of residence. This is required for non-exempt countries.
The two-letter ISO country code of the country for tax treaty purposes.
The article and paragraph of the citation claimed for tax treaty purposes.
The withholding rate claimed for tax treaty purposes. For example, a 15% rate would be represented as 0.15.
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)
interest1, dividend6, dividend7, pension15, socialSecurity, equipment10, knowhow10, patent10, film11, copyright12 An optional explanation for the tax treaty claimed.
Response
OK
Was this page helpful?