Skip to main content
PUT
Put Settings

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.