Skip to main content

SimpleKYC connector — overview

The SimpleKYC connector is Ark's business verification (KYB) connector. It fulfils the business side of Ark's unified KYX contract — searching the registry, opening a verification, retrieving status and the full business report (ownership, officeholders, ASIC/ABR results, PEP & sanctions) — by calling the SimpleKYC HTTP API. It stores only the mapping between the Ark verification id and the SimpleKYC application id.

SimpleKYC is the business / KYB counterpart to Ark's individual-identity (KYX) connector, which handles individual KYX. Both expose the same /v1/kyx connector contract.

What it does

CapabilityEndpoint
Search for a business entityGET /v1/kyx/search
Open a business verificationPOST /v1/kyx
Check verification statusGET /v1/kyx/{id}
Upload a supporting documentPOST /v1/kyx/{id}/documents
List document/registry outcomesGET /v1/kyx/{id}/documents
Retrieve the full business reportGET /v1/kyx/{id}/verification

See endpoints for how to call them and lifecycle for how a verification progresses.

Shape

  • KYB only. This connector verifies businesses. Individual identity verification is handled separately by Ark's individual-identity (KYX) connector.
  • Stateless except for one mapping. The connector stores only the Ark↔SimpleKYC id mapping (KYB_VERIFICATION_MAPPING); status and report data are read live from SimpleKYC on each call. See the architecture's persistence model.
  • Two-leg auth to SimpleKYC. Every call sends a subscription key; most also carry a cached login bearer token (search does not). See the architecture.
You want…Doc
How to call the APIendpoints (non-dev)
How a verification progresseslifecycle (non-dev)
How it's built and per-endpoint internalsarchitecture (dev)
How to build, run, test, and regenerate clientsdevelopment (dev)
Quirks, gaps, and provider caveatsnotes (dev)

The formal request/response contract is the connector's OpenAPI specification (the KYX Check API, openapi/source/connector/kyx/kyx.yml); this doc set does not restate it. Vendor reference material is in the vendored SimpleKYC reference.