GreenID connector — overview
The GreenID connector is the identity-verification connector behind Ark's individual KYX flow. It exposes Ark's KYX connector API and fulfils each verification by calling the GreenID identity-verification service (vixverify) over SOAP.
GreenID verifies a person's identity against Australian data sources — the electoral roll, credit-header data, and government document-verification services (DVS) for driver's licences, passports, and Medicare cards — and screens against watchlists such as PEP/sanctions. Ark hides all of that behind one unified KYX contract so the platform never talks to GreenID directly.
What it does
| Capability | Endpoint | Notes |
|---|---|---|
| Start a verification | POST /v1/kyx | Registers a GreenID verification session for a person |
| Check status | GET /v1/kyx/{arkVerificationId} | Current normalised verification status |
| Submit an identity document | POST /v1/kyx/{arkVerificationId}/documents | Driver's licence, passport, or Medicare card |
| List document outcomes | GET /v1/kyx/{arkVerificationId}/documents | Per-document status derived from the latest GreenID result |
See endpoints for how to call each one, and lifecycle for how a verification moves through its states.
Shape
- Individual KYX only. This connector implements person verification. It does not perform business / KYB verification (see the connector notes for the contract surface that is declared but not implemented).
- Stateless except for one mapping. The connector stores only the link between the Ark verification id and the GreenID verification id — no document payloads, no verification results. Everything else is read back from GreenID on demand. See the architecture's persistence model.
- REST in, SOAP out. Ark callers use REST/JSON; the connector translates each call to GreenID's SOAP API (the specific service/operations are in the architecture).
Where to read next
| You want… | Doc |
|---|---|
| How to call the API | endpoints (non-dev) |
| How a verification progresses | lifecycle (non-dev) |
| How it's built and the per-endpoint internals | architecture (dev) |
| How to build, run, test, and regenerate clients | development (dev) |
| Quirks, gaps, and provider caveats | notes (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.