Run Ad Hoc Business Verification

Use the /entity/kyb/adhoc endpoint to create a business with the verification provider for an entity that does not have one yet, and run its business verification (KYB).

This endpoint is for entities that were created with ZTM skipped: the business was never created with the provider during entity creation, so no KYB result will ever arrive for them. It is not a way to re-run or refresh a verification. An entity that already has a business on record with the provider is rejected with a 409, because creating a second business would duplicate the record on the provider's side. To re-screen a business that already exists, use the KYB update flow instead.

You provide the userId of the entity, the provider to run against, and the KYB config for that provider. When you pass an idvTemplateId, the provider configuration for that template must be supplied alongside it.

The business is created with the provider and its active beneficial owners are synced in the same request, using the product the entity was onboarded with. The endpoint returns the provider's immediate response — the risk level at submission plus the raw providerData — along with the spidrActionId of the action created for the run. The verification result arrives asynchronously: once the provider's KYB webhook lands, the KYB session is completed and the outcome is recorded on that action, which you can then retrieve and decision like any other action.

A KYB run that is still pending for the same entity and product also blocks a new one, so a call made while a run is in flight is rejected rather than creating and billing a duplicate business.

Body Params

POST /v1/entity/kyb/adhoc Request body

string
enum
required
Allowed:
string
required

The user's unique ID within Spidr

string

The ID of the Spidr IDV template to run

config
object

Configuration for the business check.

Responses

Language
Credentials
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json