GET
/v1/workspace/disclosure-statesRead the states this workspace discloses in
The seven US states with a commercial financing disclosure law (CA, NY, UT, VA, GA, FL, CT) plus any this workspace added, each saying whether the law wants the merchant's signature. Reach for it to decide whether a submission needs a disclosure before it goes to a lender.
Access class: workspace.
Send request
Use the documented inputs to call this endpoint directly.
API serverbase URL
Bearer tokensessionoptional
Stored only in this browser for the session security scheme and reused on every API page in this group.
Parameters
Values are applied to the request and the example on the right.
bodyquery · nulloptional
paramsquery · objectoptional
queryquery · objectoptional
Responses
200application/json
the action's answer
{
"data": [
{
"signatureRequired": true,
"state": "string",
"statutory": true
}
]
}dataarray<>required
defaultapplication/json
a refusal: {"error": "<what a person needs to read>"}. 401 no credential, 402 the plan does not include this, 403 the seat does not, 404 the thing does not exist or is not yours to see.
{
"error": "string"
}errorstringrequired