ClientService

Lookup KYB Verification Region

Looks up the company documents and other KYB-specific data for one jurisdiction and state, with jurisdiction-specific document names. A region that is not KYB_VERIFICATION-capable returns NOT_FOUND. The catalog changes only on release; cache the response for up to 24 hours. An INVALID_ARGUMENT for an unavailable document type on CreateCheck means the cached catalog is stale.

get/v1alpha2/kybVerificationRegions:lookup

Request

  • Base URL: https://api.thirdfort.dev/client/api
  • URL: https://api.thirdfort.dev/client/api/v1alpha2/kybVerificationRegions:lookup
  • Auth: HTTP bearer

Query parameters

region.jurisdictionstring required

Required. The jurisdiction code, matching Jurisdiction.code.

region.statestring

The subdivision code, matching Jurisdiction.Subdivision.code. Set only where the capability requires a subdivision.

Response

A successful response.

namestring

The resource name of the region. The ID is the lowercase jurisdiction code, followed by "-" and the lowercase subdivision code where one is required. Format: kybVerificationRegions/{kyb_verification_region}, e.g. kybVerificationRegions/gb, kybVerificationRegions/us-ca.

Changes