Skip to main content
PUT
/
v2
/
kyb
/
settings
Put Settings
curl --request PUT \
  --url https://api.example.com/v2/kyb/settings \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "website_analysis_enabled": true,
  "naics_prediction_enabled": true,
  "lien_search_enabled": true,
  "monthly_verification_limit": 1
}
'
{
  "created_at": "2023-11-07T05:31:56Z",
  "modified_at": "2023-11-07T05:31:56Z",
  "website_analysis_enabled": true,
  "naics_prediction_enabled": true,
  "lien_search_enabled": true,
  "monthly_verification_limit": 123,
  "verifications_used": 0,
  "object": "<string>"
}

Documentation Index

Fetch the complete documentation index at: https://docs.api.stuut.co/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json

Request to update KYB settings.

​
website_analysis_enabled
boolean | null
​
naics_prediction_enabled
boolean | null
​
lien_search_enabled
boolean | null
​
monthly_verification_limit
integer | null
Required range: x >= 0

Response

Successful Response

KYB configuration for the organization.

​
created_at
string<date-time>
required
​
modified_at
string<date-time> | null
required
​
website_analysis_enabled
boolean
required

Include website discovery and analysis in KYB verifications.

​
naics_prediction_enabled
boolean
required

Include industry (NAICS) prediction in KYB verifications.

​
lien_search_enabled
boolean
required

Include UCC lien search in KYB verifications.

​
monthly_verification_limit
integer
required

Maximum number of KYB verifications allowed per calendar month.

​
verifications_used
integer
default:0
required
​
object
string
required
read-only

String representing the object's type. Objects of the same type share the same value.