PUT
/v1/workspace/kycReplace workspace kyc
Save the workspace's KYC file WITHOUT attesting to it, so a half-finished form survives closing the pane. Fields are flat strings under fields; a field name this service does not know is a 400 rather than a silent drop. ADMIN OR OWNER — it is the company's paperwork. Attesting is the submit route beside it.
Access class: workspace:admin.
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.
Request body
application/jsonrequiredbodyoptional
paramsobjectoptional
queryobjectoptional
Responses
200application/json
the action's answer
{
"data": {
"kycStatus": "string",
"lendersUnlocked": true,
"msaSigned": true,
"msaVersion": "string",
"unlocked": true,
"workspace": {
"agreement": {
"signedByWorkspace": true,
"version": "string"
},
"kycFields": {
"authorized_signer_email": "string",
"authorized_signer_name": "string",
"authorized_signer_title": "string",
"dba": "string",
"entity_type": "string",
"legal_name": "string",
"notice_address": "string",
"notice_email": "string",
"tax_id_last4": "string"
},
"kycMissingFields": [
"string"
],
"kycStatus": "string"
},
"you": {
"msaSigned": true,
"msaVersion": "string",
"needsKyc": true
}
}
}datarequired
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