{"openapi":"3.1.0","info":{"title":"Australian Identity Solutions API","version":"1.0.0","description":"Identity verification (photo ID, selfie + liveness, face match and AML screening) for Australian businesses.\n\nAuthenticate with your secret key: `Authorization: Bearer ais_live_...` (or `ais_test_...` for test mode). The legacy `x-api-key` header is also accepted. Secret keys are for servers only.\n\nPlan: API access (this API, the SDK, the widget, webhooks and test mode) is included with the Growth plan ($299/month, 75 checks included, then $3.99 each) and Enterprise only. Pay As You Go is a dashboard-only plan; Business adds Zapier (no API). Keys of an account on any other plan get `403` with `{ \"error\": { \"type\": \"permission_error\", \"code\": \"plan_required\" } }`, including keys created before a downgrade; they work again after upgrading.\n\nAll responses are JSON in snake_case. Errors look like `{ \"error\": { \"type\", \"code\", \"message\", \"param\" } }`. POST requests accept an `Idempotency-Key` header (same key and body within 24 hours returns the original response). Rate limit: 100 requests per minute per account and mode; a 429 carries `Retry-After` (seconds).\n\nCharging: a check is charged once, when it completes (approved or declined). A check in review is charged once the review ends with a result. Abandoned, expired and canceled checks are not charged. Test-mode checks are never charged.\n\nCompany checks (KYB): $39.99 AUD each, charged when the company check completes (approved or declined), including ONE director/owner ID check. Every further director or beneficial owner is a normal identity check ($9.99 on Pay As You Go; Growth plan checks use included checks / overage), charged as it completes.\n\nOngoing AML monitoring: daily sanctions / PEP / adverse media re-screening of a verified person. $1.00 AUD per person per year on Pay As You Go (charged when switched on, then yearly), free on the Business and Growth plans. Switching it off is not refunded. AIS is not registered for GST; prices include no GST.\n\nProducts (AUD, no GST; charged only when they complete, never in test mode; on Business / Growth these are charged from credit on top and never use included checks, except the ID check bundled with Verify + Sign): Verify + Sign $4.99 per signing or $12.99 with an ID check; re-verification $2.99; selfie age check $1.99; proof of address $4.99; document reading $1.99 (included with a company check); wallet screening $1.99; duplicate / fraud detection $0.99 per check; source-of-funds questionnaire and phone / email codes free with a check; transaction monitoring (Growth / Enterprise) 1,000 a month free then $0.01 each.","contact":{"name":"Australian Identity Solutions","email":"info@australianidentitysolutions.com.au","url":"https://australianidentitysolutions.com.au"}},"servers":[{"url":"https://portal.australianidentitysolutions.com.au"}],"security":[{"bearerAuth":[]},{"apiKeyHeader":[]}],"tags":[{"name":"Verifications","description":"Create and read identity checks."},{"name":"Company checks","description":"Verify a business (KYB): registry lookup, company AML, and ID checks for its directors and beneficial owners."},{"name":"Monitoring","description":"Ongoing AML monitoring of verified people."},{"name":"Account","description":"Plan and credit."},{"name":"SDK","description":"Browser endpoints used by the front-end SDK (publishable key or client token)."},{"name":"Verify + Sign","description":"E-signature of an uploaded PDF, optionally after an ID check."},{"name":"Re-verification","description":"Confirm the same person is present (selfie liveness + face match)."},{"name":"Age checks","description":"Selfie age estimation with an ID-check fallback."},{"name":"Proof of address","description":"Read and check a utility bill, bank statement or government letter."},{"name":"Document reading","description":"Extract fields from trust deeds, rates notices, company papers."},{"name":"Wallet screening","description":"Crypto wallet risk screening."},{"name":"Fraud detection","description":"Blocklist for duplicate / fraud detection."},{"name":"Transaction monitoring","description":"Monitor transactions and review alerts (Growth / Enterprise)."}],"paths":{"/api/v1/signatures":{"post":{"tags":["Verify + Sign"],"operationId":"create_signatures","summary":"Send a PDF to be signed","description":"Upload a PDF (base64, max 3 MB, not password-protected). The customer gets one branded link: an optional ID check first (`with_id_check`), then they read the document and sign it. $4.99 per signing, or $12.99 with the ID check (Business / Growth: the ID check uses an included check, then signing $4.99). Charged when signed. A declined request that included the ID check is charged for the ID check only ($9.99, or an included check / overage on Business and Growth); signing-only declines, and expired requests, are free. When signed, `files` holds the signed PDF and our evidence certificate. This is an electronic signature; it is not a qualified electronic signature and not a verification of identity (VOI) under the ARNECC rules.","parameters":[{"$ref":"#/components/parameters/IdempotencyKey"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateSignatureRequest"}}}},"responses":{"201":{"description":"Created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Product"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"402":{"$ref":"#/components/responses/PaymentRequired"},"403":{"$ref":"#/components/responses/Forbidden"},"409":{"$ref":"#/components/responses/Conflict"},"413":{"description":"Body too large (files up to 3 MB)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"$ref":"#/components/responses/TooManyRequests"},"503":{"$ref":"#/components/responses/ServerError"}}},"get":{"tags":["Verify + Sign"],"operationId":"list_signatures","summary":"List signature requests","parameters":[{"name":"limit","in":"query","schema":{"type":"integer","minimum":1,"maximum":100,"default":20}},{"name":"starting_after","in":"query","schema":{"type":"string"}},{"name":"status","in":"query","schema":{"$ref":"#/components/schemas/ProductStatus"}},{"name":"reference","in":"query","schema":{"type":"string","maxLength":200}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProductList"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"}}}},"/api/v1/signatures/{id}":{"get":{"tags":["Verify + Sign"],"operationId":"get_signatures","summary":"Retrieve a signature request","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Product"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"}}}},"/api/v1/signatures/{id}/cancel":{"post":{"tags":["Verify + Sign"],"operationId":"cancel_signatures","summary":"Cancel an open signature request","description":"Pending or in progress only. Never charged.","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}},{"$ref":"#/components/parameters/IdempotencyKey"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Product"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"409":{"$ref":"#/components/responses/Conflict"}}}},"/api/v1/signatures/{id}/files/{fileId}":{"get":{"tags":["Verify + Sign"],"operationId":"file_signatures","summary":"Download a file (uploaded, signed or evidence)","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}},{"name":"fileId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"The file","content":{"application/pdf":{"schema":{"type":"string","format":"binary"}},"image/*":{"schema":{"type":"string","format":"binary"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"}}}},"/api/v1/age_checks":{"post":{"tags":["Age checks"],"operationId":"create_age_checks","summary":"Request a selfie age check","description":"The customer takes one selfie; their age is estimated against `threshold` (18, 21 or 25). `result`: `over`, `under`, or `refer_to_id` when the estimate is within 3 years of the threshold and `fallback_to_id` is on (default) - then a normal ID check is sent (normal check price) and its id is in `output.fallback_verification_id`. `output.estimated_age_band` (e.g. `25_29`); the exact estimate is not returned. $1.99 when it completes.","parameters":[{"$ref":"#/components/parameters/IdempotencyKey"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateAgeCheckRequest"}}}},"responses":{"201":{"description":"Created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Product"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"402":{"$ref":"#/components/responses/PaymentRequired"},"403":{"$ref":"#/components/responses/Forbidden"},"409":{"$ref":"#/components/responses/Conflict"},"413":{"description":"Body too large (files up to 3 MB)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"$ref":"#/components/responses/TooManyRequests"},"503":{"$ref":"#/components/responses/ServerError"}}},"get":{"tags":["Age checks"],"operationId":"list_age_checks","summary":"List age checks","parameters":[{"name":"limit","in":"query","schema":{"type":"integer","minimum":1,"maximum":100,"default":20}},{"name":"starting_after","in":"query","schema":{"type":"string"}},{"name":"status","in":"query","schema":{"$ref":"#/components/schemas/ProductStatus"}},{"name":"reference","in":"query","schema":{"type":"string","maxLength":200}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProductList"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"}}}},"/api/v1/age_checks/{id}":{"get":{"tags":["Age checks"],"operationId":"get_age_checks","summary":"Retrieve a age check","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Product"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"}}}},"/api/v1/age_checks/{id}/cancel":{"post":{"tags":["Age checks"],"operationId":"cancel_age_checks","summary":"Cancel an open age check","description":"Pending or in progress only. Never charged.","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}},{"$ref":"#/components/parameters/IdempotencyKey"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Product"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"409":{"$ref":"#/components/responses/Conflict"}}}},"/api/v1/age_checks/{id}/report.pdf":{"get":{"tags":["Age checks"],"operationId":"report_age_checks","summary":"Download the PDF report","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"PDF","content":{"application/pdf":{"schema":{"type":"string","format":"binary"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"409":{"$ref":"#/components/responses/Conflict"}}}},"/api/v1/address_checks":{"post":{"tags":["Proof of address"],"operationId":"create_address_checks","summary":"Check a proof of address","description":"Utility bill, bank statement or government letter. Give `document` to check it now, or omit it and the customer gets a link to upload it. We read the name and address, compare the name with the verified ID name (`verification_id`) or `customer.name`, and check the issue date is within `max_age_days` (default 90). `result`: `accepted`, `rejected` or `review`. $4.99 when it completes.","parameters":[{"$ref":"#/components/parameters/IdempotencyKey"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateAddressCheckRequest"}}}},"responses":{"201":{"description":"Created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Product"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"402":{"$ref":"#/components/responses/PaymentRequired"},"403":{"$ref":"#/components/responses/Forbidden"},"409":{"$ref":"#/components/responses/Conflict"},"413":{"description":"Body too large (files up to 3 MB)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"$ref":"#/components/responses/TooManyRequests"},"503":{"$ref":"#/components/responses/ServerError"}}},"get":{"tags":["Proof of address"],"operationId":"list_address_checks","summary":"List address checks","parameters":[{"name":"limit","in":"query","schema":{"type":"integer","minimum":1,"maximum":100,"default":20}},{"name":"starting_after","in":"query","schema":{"type":"string"}},{"name":"status","in":"query","schema":{"$ref":"#/components/schemas/ProductStatus"}},{"name":"reference","in":"query","schema":{"type":"string","maxLength":200}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProductList"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"}}}},"/api/v1/address_checks/{id}":{"get":{"tags":["Proof of address"],"operationId":"get_address_checks","summary":"Retrieve a address check","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Product"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"}}}},"/api/v1/address_checks/{id}/cancel":{"post":{"tags":["Proof of address"],"operationId":"cancel_address_checks","summary":"Cancel an open address check","description":"Pending or in progress only. Never charged.","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}},{"$ref":"#/components/parameters/IdempotencyKey"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Product"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"409":{"$ref":"#/components/responses/Conflict"}}}},"/api/v1/address_checks/{id}/files/{fileId}":{"get":{"tags":["Proof of address"],"operationId":"file_address_checks","summary":"Download a file (uploaded, signed or evidence)","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}},{"name":"fileId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"The file","content":{"application/pdf":{"schema":{"type":"string","format":"binary"}},"image/*":{"schema":{"type":"string","format":"binary"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"}}}},"/api/v1/address_checks/{id}/report.pdf":{"get":{"tags":["Proof of address"],"operationId":"report_address_checks","summary":"Download the PDF report","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"PDF","content":{"application/pdf":{"schema":{"type":"string","format":"binary"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"409":{"$ref":"#/components/responses/Conflict"}}}},"/api/v1/documents":{"post":{"tags":["Document reading"],"operationId":"create_documents","summary":"Read a document into fields","description":"Templates: `trust_deed`, `rates_notice`, `company_extract`, or `custom` with up to 30 `fields`. Runs straight away; `output.fields` holds the values (null when not found). `result`: `extracted`, `partial` or `unreadable`. Included with a company check (give `company_check_id`), otherwise $1.99 per document.","parameters":[{"$ref":"#/components/parameters/IdempotencyKey"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateDocumentRequest"}}}},"responses":{"201":{"description":"Created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Product"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"402":{"$ref":"#/components/responses/PaymentRequired"},"403":{"$ref":"#/components/responses/Forbidden"},"409":{"$ref":"#/components/responses/Conflict"},"413":{"description":"Body too large (files up to 3 MB)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"$ref":"#/components/responses/TooManyRequests"},"503":{"$ref":"#/components/responses/ServerError"}}},"get":{"tags":["Document reading"],"operationId":"list_documents","summary":"List document readings","parameters":[{"name":"limit","in":"query","schema":{"type":"integer","minimum":1,"maximum":100,"default":20}},{"name":"starting_after","in":"query","schema":{"type":"string"}},{"name":"status","in":"query","schema":{"$ref":"#/components/schemas/ProductStatus"}},{"name":"reference","in":"query","schema":{"type":"string","maxLength":200}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProductList"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"}}}},"/api/v1/documents/{id}":{"get":{"tags":["Document reading"],"operationId":"get_documents","summary":"Retrieve a document reading","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Product"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"}}}},"/api/v1/documents/{id}/files/{fileId}":{"get":{"tags":["Document reading"],"operationId":"file_documents","summary":"Download a file (uploaded, signed or evidence)","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}},{"name":"fileId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"The file","content":{"application/pdf":{"schema":{"type":"string","format":"binary"}},"image/*":{"schema":{"type":"string","format":"binary"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"}}}},"/api/v1/documents/{id}/report.pdf":{"get":{"tags":["Document reading"],"operationId":"report_documents","summary":"Download the PDF report","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"PDF","content":{"application/pdf":{"schema":{"type":"string","format":"binary"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"409":{"$ref":"#/components/responses/Conflict"}}}},"/api/v1/wallet_screenings":{"post":{"tags":["Wallet screening"],"operationId":"create_wallet_screenings","summary":"Screen a crypto wallet","description":"Screens `address` on `chain` against sanctions and risk lists. Runs straight away. `output`: `risk_score` (0-100), `severity`, `sanctions_hit`, `categories`. `result` is the severity. $1.99 when it completes.","parameters":[{"$ref":"#/components/parameters/IdempotencyKey"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateWalletScreeningRequest"}}}},"responses":{"201":{"description":"Created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Product"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"402":{"$ref":"#/components/responses/PaymentRequired"},"403":{"$ref":"#/components/responses/Forbidden"},"409":{"$ref":"#/components/responses/Conflict"},"413":{"description":"Body too large (files up to 3 MB)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"$ref":"#/components/responses/TooManyRequests"},"503":{"$ref":"#/components/responses/ServerError"}}},"get":{"tags":["Wallet screening"],"operationId":"list_wallet_screenings","summary":"List wallet screenings","parameters":[{"name":"limit","in":"query","schema":{"type":"integer","minimum":1,"maximum":100,"default":20}},{"name":"starting_after","in":"query","schema":{"type":"string"}},{"name":"status","in":"query","schema":{"$ref":"#/components/schemas/ProductStatus"}},{"name":"reference","in":"query","schema":{"type":"string","maxLength":200}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProductList"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"}}}},"/api/v1/wallet_screenings/{id}":{"get":{"tags":["Wallet screening"],"operationId":"get_wallet_screenings","summary":"Retrieve a wallet screening","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Product"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"}}}},"/api/v1/wallet_screenings/{id}/report.pdf":{"get":{"tags":["Wallet screening"],"operationId":"report_wallet_screenings","summary":"Download the PDF report","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"PDF","content":{"application/pdf":{"schema":{"type":"string","format":"binary"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"409":{"$ref":"#/components/responses/Conflict"}}}},"/api/v1/reverifications":{"get":{"tags":["Re-verification"],"operationId":"list_reverifications","summary":"List re-verifications","parameters":[{"name":"limit","in":"query","schema":{"type":"integer","minimum":1,"maximum":100,"default":20}},{"name":"starting_after","in":"query","schema":{"type":"string"}},{"name":"status","in":"query","schema":{"$ref":"#/components/schemas/ProductStatus"}},{"name":"reference","in":"query","schema":{"type":"string","maxLength":200}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProductList"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"}}}},"/api/v1/reverifications/{id}":{"get":{"tags":["Re-verification"],"operationId":"get_reverifications","summary":"Retrieve a re-verification","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Product"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"}}}},"/api/v1/reverifications/{id}/cancel":{"post":{"tags":["Re-verification"],"operationId":"cancel_reverifications","summary":"Cancel an open re-verification","description":"Pending or in progress only. Never charged.","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}},{"$ref":"#/components/parameters/IdempotencyKey"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Product"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"409":{"$ref":"#/components/responses/Conflict"}}}},"/api/v1/reverifications/{id}/report.pdf":{"get":{"tags":["Re-verification"],"operationId":"report_reverifications","summary":"Download the PDF report","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"PDF","content":{"application/pdf":{"schema":{"type":"string","format":"binary"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"409":{"$ref":"#/components/responses/Conflict"}}}},"/api/v1/verifications/{id}/reverify":{"post":{"tags":["Re-verification"],"operationId":"reverifyVerification","summary":"Re-verify the same person","description":"For an approved verification. The customer gets a link to take one selfie; we check liveness and compare the face with this verification (e.g. before a bank detail change). `result`: `match` or `no_match`; event `reverification.completed`. $2.99 when it completes.","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}},{"$ref":"#/components/parameters/IdempotencyKey"}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ReverifyRequest"}}}},"responses":{"201":{"description":"Created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Product"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"402":{"$ref":"#/components/responses/PaymentRequired"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"409":{"$ref":"#/components/responses/Conflict"},"413":{"description":"Body too large (files up to 3 MB)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"$ref":"#/components/responses/TooManyRequests"},"503":{"$ref":"#/components/responses/ServerError"}}}},"/api/v1/verifications/{id}/block":{"post":{"tags":["Fraud detection"],"operationId":"blockVerification","summary":"Add or remove a person on your blocklist","description":"Your account's blocklist for duplicate / fraud detection: later fraud checks whose face matches a blocked verification are flagged `blocklisted`.","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}},{"$ref":"#/components/parameters/IdempotencyKey"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","additionalProperties":false,"required":["blocked"],"properties":{"blocked":{"type":"boolean"},"reason":{"type":"string","maxLength":300}}}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"object":{"const":"blocklist_entry"},"verification_id":{"type":"string"},"blocked":{"type":"boolean"},"livemode":{"type":"boolean"}}}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"}}}},"/api/v1/transactions":{"post":{"tags":["Transaction monitoring"],"operationId":"createTransaction","summary":"Submit a transaction for monitoring","description":"Growth / Enterprise. Checked against monitoring rules; anything that triggers a rule gets `alert_status: open` and fires `transaction.alert`. `transaction_id` must be unique per account and mode (409 otherwise). First 1,000 live transactions a month free, then $0.01 each. Test mode: sample rules (amount >= 10,000; high-risk countries), never charged.","parameters":[{"$ref":"#/components/parameters/IdempotencyKey"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateTransactionRequest"}}}},"responses":{"201":{"description":"Created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Transaction"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"402":{"$ref":"#/components/responses/PaymentRequired"},"403":{"$ref":"#/components/responses/Forbidden"},"409":{"$ref":"#/components/responses/Conflict"},"413":{"description":"Body too large (files up to 3 MB)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"$ref":"#/components/responses/TooManyRequests"},"503":{"$ref":"#/components/responses/ServerError"}}},"get":{"tags":["Transaction monitoring"],"operationId":"listTransactions","summary":"List transactions (alert_status=open for the alert queue)","parameters":[{"name":"limit","in":"query","schema":{"type":"integer","minimum":1,"maximum":100,"default":20}},{"name":"starting_after","in":"query","schema":{"type":"string"}},{"name":"alert_status","in":"query","schema":{"type":"string","enum":["none","open","resolved"]}},{"name":"verification_id","in":"query","schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"object":{"const":"list"},"url":{"type":"string"},"has_more":{"type":"boolean"},"data":{"type":"array","items":{"$ref":"#/components/schemas/Transaction"}}}}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"}}}},"/api/v1/transactions/{id}":{"get":{"tags":["Transaction monitoring"],"operationId":"getTransaction","summary":"Retrieve a transaction","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Transaction"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"}}}},"/api/v1/transactions/{id}/resolve":{"post":{"tags":["Transaction monitoring"],"operationId":"resolveTransactionAlert","summary":"Resolve an open alert","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}},{"$ref":"#/components/parameters/IdempotencyKey"}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","additionalProperties":false,"properties":{"note":{"type":"string","maxLength":1000}}}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Transaction"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"409":{"$ref":"#/components/responses/Conflict"}}}},"/api/v1/verifications":{"post":{"tags":["Verifications"],"operationId":"createVerification","summary":"Create a verification","description":"Creates a check and returns its customer link (`verification_url`) and a short-lived `client_token` for the front-end SDK. If `customer.email` is given we email the link (set `send_email: false` to deliver it yourself). Without an email, nothing is sent. Live mode checks your credit first and returns 402 if it does not cover the check.","parameters":[{"$ref":"#/components/parameters/IdempotencyKey"}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateVerificationRequest"}}}},"responses":{"201":{"description":"Created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/VerificationWithClientToken"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"402":{"$ref":"#/components/responses/PaymentRequired"},"403":{"$ref":"#/components/responses/Forbidden"},"409":{"$ref":"#/components/responses/Conflict"},"429":{"$ref":"#/components/responses/TooManyRequests"},"500":{"$ref":"#/components/responses/ServerError"}}},"get":{"tags":["Verifications"],"operationId":"listVerifications","summary":"List verifications","description":"Newest first. Cursor pagination: pass the last `id` you received as `starting_after`.","parameters":[{"name":"limit","in":"query","schema":{"type":"integer","minimum":1,"maximum":100,"default":20}},{"name":"starting_after","in":"query","schema":{"type":"string"},"description":"A verification id; returns the items after it."},{"name":"status","in":"query","schema":{"$ref":"#/components/schemas/VerificationStatus"}},{"name":"result","in":"query","schema":{"type":"string","enum":["approved","declined"]}},{"name":"reference","in":"query","schema":{"type":"string","maxLength":200}},{"name":"created[gte]","in":"query","schema":{"oneOf":[{"type":"integer"},{"type":"string","format":"date-time"}]},"description":"Unix seconds or ISO 8601."},{"name":"created[lte]","in":"query","schema":{"oneOf":[{"type":"integer"},{"type":"string","format":"date-time"}]},"description":"Unix seconds or ISO 8601."}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/VerificationList"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"429":{"$ref":"#/components/responses/TooManyRequests"}}}},"/api/v1/verifications/{id}":{"get":{"tags":["Verifications"],"operationId":"getVerification","summary":"Retrieve a verification","parameters":[{"$ref":"#/components/parameters/VerificationId"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Verification"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"429":{"$ref":"#/components/responses/TooManyRequests"}}}},"/api/v1/verifications/{id}/cancel":{"post":{"tags":["Verifications"],"operationId":"cancelVerification","summary":"Cancel an open verification","description":"Only for checks that are `pending` or `in_progress` (not `in_review`). The link stops working and the check is never charged.","parameters":[{"$ref":"#/components/parameters/VerificationId"},{"$ref":"#/components/parameters/IdempotencyKey"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Verification"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"409":{"$ref":"#/components/responses/Conflict"}}}},"/api/v1/verifications/{id}/client_token":{"post":{"tags":["Verifications"],"operationId":"createClientToken","summary":"Create a new client token","description":"Client tokens last one hour. Mint a fresh one for an open check before mounting the SDK again.","parameters":[{"$ref":"#/components/parameters/VerificationId"}],"responses":{"201":{"description":"Created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ClientToken"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"409":{"$ref":"#/components/responses/Conflict"}}}},"/api/v1/verifications/{id}/report.pdf":{"get":{"tags":["Verifications"],"operationId":"getVerificationReport","summary":"Download the PDF report","description":"Available once the check has completed (approved or declined). Test-mode reports are built from simulated data and marked TEST.","parameters":[{"$ref":"#/components/parameters/VerificationId"}],"responses":{"200":{"description":"PDF","content":{"application/pdf":{"schema":{"type":"string","format":"binary"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"409":{"$ref":"#/components/responses/Conflict"}}}},"/api/v1/verifications/{id}/monitoring":{"post":{"tags":["Monitoring"],"operationId":"setVerificationMonitoring","summary":"Switch ongoing AML monitoring on or off","description":"Only for approved (completed) verifications. Switching on charges $1.00 for the first year on Pay As You Go (free on Business and in test mode) and returns 402 if credit does not cover it. It renews yearly. Switching off stops re-screening; the year already paid is not refunded, and switching back on inside it is free. New or changed matches fire `verification.monitoring_alert`.","parameters":[{"$ref":"#/components/parameters/VerificationId"},{"$ref":"#/components/parameters/IdempotencyKey"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","additionalProperties":false,"required":["enabled"],"properties":{"enabled":{"type":"boolean"}}}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Verification"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"402":{"$ref":"#/components/responses/PaymentRequired"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"409":{"$ref":"#/components/responses/Conflict"}}}},"/api/v1/verifications/{id}/monitoring/simulate_alert":{"post":{"tags":["Monitoring"],"operationId":"simulateMonitoringAlert","summary":"Simulate a monitoring alert (test mode only)","description":"Test secret keys only, on a test verification with monitoring on. Runs the real alert path: monitoring.status becomes `alert`, your team is emailed (marked TEST) and `verification.monitoring_alert` is sent to your test endpoints.","parameters":[{"$ref":"#/components/parameters/VerificationId"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Verification"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"409":{"$ref":"#/components/responses/Conflict"}}}},"/api/v1/companies":{"post":{"tags":["Company checks"],"operationId":"createCompanyCheck","summary":"Create a company check","description":"Give at least one of `company.name`, `company.abn` or `company.acn`. We email the contact a secure link (set `send_email: false` to deliver `verification_url` yourself). They confirm the company on the register and declare its directors and beneficial owners (25%+). When the company check is approved, each person gets their own identity verification (linked by `company_check_id`). A valid ABN is also checked against the Australian Business Register (status, entity type, GST). Live mode checks your credit first (402).","parameters":[{"$ref":"#/components/parameters/IdempotencyKey"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateCompanyCheckRequest"}}}},"responses":{"201":{"description":"Created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CompanyCheck"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"402":{"$ref":"#/components/responses/PaymentRequired"},"403":{"$ref":"#/components/responses/Forbidden"},"409":{"$ref":"#/components/responses/Conflict"},"429":{"$ref":"#/components/responses/TooManyRequests"},"503":{"$ref":"#/components/responses/ServerError"}}},"get":{"tags":["Company checks"],"operationId":"listCompanyChecks","summary":"List company checks","description":"Newest first. Cursor pagination with `starting_after`.","parameters":[{"name":"limit","in":"query","schema":{"type":"integer","minimum":1,"maximum":100,"default":20}},{"name":"starting_after","in":"query","schema":{"type":"string"}},{"name":"status","in":"query","schema":{"$ref":"#/components/schemas/VerificationStatus"}},{"name":"result","in":"query","schema":{"type":"string","enum":["approved","declined"]}},{"name":"reference","in":"query","schema":{"type":"string","maxLength":200}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CompanyCheckList"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"429":{"$ref":"#/components/responses/TooManyRequests"}}}},"/api/v1/companies/{id}":{"get":{"tags":["Company checks"],"operationId":"getCompanyCheck","summary":"Retrieve a company check","parameters":[{"$ref":"#/components/parameters/CompanyCheckId"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CompanyCheck"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"}}}},"/api/v1/companies/{id}/report.pdf":{"get":{"tags":["Company checks"],"operationId":"getCompanyCheckReport","summary":"Download the company PDF report","description":"Available once the company check has completed. Company, registry facts, ABN Lookup, company AML and the people table with each person's result.","parameters":[{"$ref":"#/components/parameters/CompanyCheckId"}],"responses":{"200":{"description":"PDF","content":{"application/pdf":{"schema":{"type":"string","format":"binary"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"409":{"$ref":"#/components/responses/Conflict"}}}},"/api/v1/account":{"get":{"tags":["Account"],"operationId":"getAccount","summary":"Plan, credit balance and included checks","responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Account"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"}}}},"/api/v1/sdk/verifications":{"post":{"tags":["SDK"],"operationId":"sdkCreateVerification","summary":"Create an anonymous check from a browser (publishable key)","description":"Used by the SDK in publishable-key mode. If the account lists Allowed domains, the request Origin must be one of them. Inline and modal mode need the Origin in Allowed domains (an account with none gets 403 origin_not_allowed before any check is created); use mode redirect to open verification_url instead. The SDK creates the check when the customer clicks Begin, not on page load. Returns no results, ever.","security":[{"publishableKey":[]}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SdkCreateRequest"}}}},"responses":{"201":{"description":"Created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SdkVerification"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"402":{"$ref":"#/components/responses/PaymentRequired"},"403":{"$ref":"#/components/responses/Forbidden"},"429":{"$ref":"#/components/responses/TooManyRequests"}}}},"/api/v1/sdk/verification":{"get":{"tags":["SDK"],"operationId":"sdkGetVerification","summary":"Status of the check a client token is for","security":[{"clientToken":[]}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SdkVerification"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"}}}}},"webhooks":{"verification.created":{"post":{"summary":"verification.created","description":"A verification was created (API, SDK, widget or dashboard).\n\nSigned with `AIS-Signature: t=<unix seconds>,v1=<hex HMAC-SHA256 of \"<t>.<raw body>\" with your endpoint secret>`. Reject requests whose t is more than 5 minutes from now. Respond 2xx within 10 seconds; anything else is retried after 1m, 5m, 30m, 2h, 8h and 24h.","parameters":[{"name":"AIS-Signature","in":"header","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Event"}}}},"responses":{"200":{"description":"Received"}}}},"verification.started":{"post":{"summary":"verification.started","description":"The customer opened the check and started it.\n\nSigned with `AIS-Signature: t=<unix seconds>,v1=<hex HMAC-SHA256 of \"<t>.<raw body>\" with your endpoint secret>`. Reject requests whose t is more than 5 minutes from now. Respond 2xx within 10 seconds; anything else is retried after 1m, 5m, 30m, 2h, 8h and 24h.","parameters":[{"name":"AIS-Signature","in":"header","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Event"}}}},"responses":{"200":{"description":"Received"}}}},"verification.review":{"post":{"summary":"verification.review","description":"The check needs your review: approve or decline it on the check's page in the dashboard. A final result follows.\n\nSigned with `AIS-Signature: t=<unix seconds>,v1=<hex HMAC-SHA256 of \"<t>.<raw body>\" with your endpoint secret>`. Reject requests whose t is more than 5 minutes from now. Respond 2xx within 10 seconds; anything else is retried after 1m, 5m, 30m, 2h, 8h and 24h.","parameters":[{"name":"AIS-Signature","in":"header","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Event"}}}},"responses":{"200":{"description":"Received"}}}},"verification.completed":{"post":{"summary":"verification.completed","description":"The check finished and was approved.\n\nSigned with `AIS-Signature: t=<unix seconds>,v1=<hex HMAC-SHA256 of \"<t>.<raw body>\" with your endpoint secret>`. Reject requests whose t is more than 5 minutes from now. Respond 2xx within 10 seconds; anything else is retried after 1m, 5m, 30m, 2h, 8h and 24h.","parameters":[{"name":"AIS-Signature","in":"header","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Event"}}}},"responses":{"200":{"description":"Received"}}}},"verification.failed":{"post":{"summary":"verification.failed","description":"The check finished and was declined.\n\nSigned with `AIS-Signature: t=<unix seconds>,v1=<hex HMAC-SHA256 of \"<t>.<raw body>\" with your endpoint secret>`. Reject requests whose t is more than 5 minutes from now. Respond 2xx within 10 seconds; anything else is retried after 1m, 5m, 30m, 2h, 8h and 24h.","parameters":[{"name":"AIS-Signature","in":"header","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Event"}}}},"responses":{"200":{"description":"Received"}}}},"verification.expired":{"post":{"summary":"verification.expired","description":"The link expired or the customer abandoned the check. Not charged.\n\nSigned with `AIS-Signature: t=<unix seconds>,v1=<hex HMAC-SHA256 of \"<t>.<raw body>\" with your endpoint secret>`. Reject requests whose t is more than 5 minutes from now. Respond 2xx within 10 seconds; anything else is retried after 1m, 5m, 30m, 2h, 8h and 24h.","parameters":[{"name":"AIS-Signature","in":"header","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Event"}}}},"responses":{"200":{"description":"Received"}}}},"verification.canceled":{"post":{"summary":"verification.canceled","description":"You canceled the check before it finished. Not charged.\n\nSigned with `AIS-Signature: t=<unix seconds>,v1=<hex HMAC-SHA256 of \"<t>.<raw body>\" with your endpoint secret>`. Reject requests whose t is more than 5 minutes from now. Respond 2xx within 10 seconds; anything else is retried after 1m, 5m, 30m, 2h, 8h and 24h.","parameters":[{"name":"AIS-Signature","in":"header","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Event"}}}},"responses":{"200":{"description":"Received"}}}},"verification.monitoring_alert":{"post":{"summary":"verification.monitoring_alert","description":"Ongoing AML monitoring found a new or changed sanctions / PEP / adverse media match for a monitored person.\n\nSigned with `AIS-Signature: t=<unix seconds>,v1=<hex HMAC-SHA256 of \"<t>.<raw body>\" with your endpoint secret>`. Reject requests whose t is more than 5 minutes from now. Respond 2xx within 10 seconds; anything else is retried after 1m, 5m, 30m, 2h, 8h and 24h.","parameters":[{"name":"AIS-Signature","in":"header","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Event"}}}},"responses":{"200":{"description":"Received"}}}},"verification.fraud_flag":{"post":{"summary":"verification.fraud_flag","description":"Duplicate / fraud detection found the same face under a different identity in your account, or a face on your blocklist.\n\nSigned with `AIS-Signature: t=<unix seconds>,v1=<hex HMAC-SHA256 of \"<t>.<raw body>\" with your endpoint secret>`. Reject requests whose t is more than 5 minutes from now. Respond 2xx within 10 seconds; anything else is retried after 1m, 5m, 30m, 2h, 8h and 24h.","parameters":[{"name":"AIS-Signature","in":"header","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Event"}}}},"responses":{"200":{"description":"Received"}}}},"company_check.created":{"post":{"summary":"company_check.created","description":"A company check (KYB) was created.\n\nSigned with `AIS-Signature: t=<unix seconds>,v1=<hex HMAC-SHA256 of \"<t>.<raw body>\" with your endpoint secret>`. Reject requests whose t is more than 5 minutes from now. Respond 2xx within 10 seconds; anything else is retried after 1m, 5m, 30m, 2h, 8h and 24h.","parameters":[{"name":"AIS-Signature","in":"header","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CompanyCheckEvent"}}}},"responses":{"200":{"description":"Received"}}}},"company_check.completed":{"post":{"summary":"company_check.completed","description":"The company check finished and was approved. Directors and owners have been sent their ID checks.\n\nSigned with `AIS-Signature: t=<unix seconds>,v1=<hex HMAC-SHA256 of \"<t>.<raw body>\" with your endpoint secret>`. Reject requests whose t is more than 5 minutes from now. Respond 2xx within 10 seconds; anything else is retried after 1m, 5m, 30m, 2h, 8h and 24h.","parameters":[{"name":"AIS-Signature","in":"header","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CompanyCheckEvent"}}}},"responses":{"200":{"description":"Received"}}}},"company_check.failed":{"post":{"summary":"company_check.failed","description":"The company check finished and was declined.\n\nSigned with `AIS-Signature: t=<unix seconds>,v1=<hex HMAC-SHA256 of \"<t>.<raw body>\" with your endpoint secret>`. Reject requests whose t is more than 5 minutes from now. Respond 2xx within 10 seconds; anything else is retried after 1m, 5m, 30m, 2h, 8h and 24h.","parameters":[{"name":"AIS-Signature","in":"header","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CompanyCheckEvent"}}}},"responses":{"200":{"description":"Received"}}}},"company_check.expired":{"post":{"summary":"company_check.expired","description":"The company check link expired or was abandoned. Not charged.\n\nSigned with `AIS-Signature: t=<unix seconds>,v1=<hex HMAC-SHA256 of \"<t>.<raw body>\" with your endpoint secret>`. Reject requests whose t is more than 5 minutes from now. Respond 2xx within 10 seconds; anything else is retried after 1m, 5m, 30m, 2h, 8h and 24h.","parameters":[{"name":"AIS-Signature","in":"header","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CompanyCheckEvent"}}}},"responses":{"200":{"description":"Received"}}}},"signature.completed":{"post":{"summary":"signature.completed","description":"The customer signed the document (Verify + Sign). The signed PDF and evidence certificate are ready.\n\nSigned with `AIS-Signature: t=<unix seconds>,v1=<hex HMAC-SHA256 of \"<t>.<raw body>\" with your endpoint secret>`. Reject requests whose t is more than 5 minutes from now. Respond 2xx within 10 seconds; anything else is retried after 1m, 5m, 30m, 2h, 8h and 24h.","parameters":[{"name":"AIS-Signature","in":"header","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProductEvent"}}}},"responses":{"200":{"description":"Received"}}}},"signature.declined":{"post":{"summary":"signature.declined","description":"The customer declined to sign, or the bundled ID check was declined. Not charged.\n\nSigned with `AIS-Signature: t=<unix seconds>,v1=<hex HMAC-SHA256 of \"<t>.<raw body>\" with your endpoint secret>`. Reject requests whose t is more than 5 minutes from now. Respond 2xx within 10 seconds; anything else is retried after 1m, 5m, 30m, 2h, 8h and 24h.","parameters":[{"name":"AIS-Signature","in":"header","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProductEvent"}}}},"responses":{"200":{"description":"Received"}}}},"signature.expired":{"post":{"summary":"signature.expired","description":"The signing link expired or was abandoned. Not charged.\n\nSigned with `AIS-Signature: t=<unix seconds>,v1=<hex HMAC-SHA256 of \"<t>.<raw body>\" with your endpoint secret>`. Reject requests whose t is more than 5 minutes from now. Respond 2xx within 10 seconds; anything else is retried after 1m, 5m, 30m, 2h, 8h and 24h.","parameters":[{"name":"AIS-Signature","in":"header","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProductEvent"}}}},"responses":{"200":{"description":"Received"}}}},"reverification.completed":{"post":{"summary":"reverification.completed","description":"A re-verification finished: result is match or no_match.\n\nSigned with `AIS-Signature: t=<unix seconds>,v1=<hex HMAC-SHA256 of \"<t>.<raw body>\" with your endpoint secret>`. Reject requests whose t is more than 5 minutes from now. Respond 2xx within 10 seconds; anything else is retried after 1m, 5m, 30m, 2h, 8h and 24h.","parameters":[{"name":"AIS-Signature","in":"header","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProductEvent"}}}},"responses":{"200":{"description":"Received"}}}},"age_check.completed":{"post":{"summary":"age_check.completed","description":"A selfie age check finished: result is over, under or refer_to_id.\n\nSigned with `AIS-Signature: t=<unix seconds>,v1=<hex HMAC-SHA256 of \"<t>.<raw body>\" with your endpoint secret>`. Reject requests whose t is more than 5 minutes from now. Respond 2xx within 10 seconds; anything else is retried after 1m, 5m, 30m, 2h, 8h and 24h.","parameters":[{"name":"AIS-Signature","in":"header","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProductEvent"}}}},"responses":{"200":{"description":"Received"}}}},"address_check.completed":{"post":{"summary":"address_check.completed","description":"A proof of address check finished: result is accepted, rejected or review.\n\nSigned with `AIS-Signature: t=<unix seconds>,v1=<hex HMAC-SHA256 of \"<t>.<raw body>\" with your endpoint secret>`. Reject requests whose t is more than 5 minutes from now. Respond 2xx within 10 seconds; anything else is retried after 1m, 5m, 30m, 2h, 8h and 24h.","parameters":[{"name":"AIS-Signature","in":"header","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProductEvent"}}}},"responses":{"200":{"description":"Received"}}}},"document.completed":{"post":{"summary":"document.completed","description":"Document reading finished: result is extracted, partial or unreadable.\n\nSigned with `AIS-Signature: t=<unix seconds>,v1=<hex HMAC-SHA256 of \"<t>.<raw body>\" with your endpoint secret>`. Reject requests whose t is more than 5 minutes from now. Respond 2xx within 10 seconds; anything else is retried after 1m, 5m, 30m, 2h, 8h and 24h.","parameters":[{"name":"AIS-Signature","in":"header","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProductEvent"}}}},"responses":{"200":{"description":"Received"}}}},"wallet_screening.completed":{"post":{"summary":"wallet_screening.completed","description":"A crypto wallet screening finished, with its risk score and categories.\n\nSigned with `AIS-Signature: t=<unix seconds>,v1=<hex HMAC-SHA256 of \"<t>.<raw body>\" with your endpoint secret>`. Reject requests whose t is more than 5 minutes from now. Respond 2xx within 10 seconds; anything else is retried after 1m, 5m, 30m, 2h, 8h and 24h.","parameters":[{"name":"AIS-Signature","in":"header","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProductEvent"}}}},"responses":{"200":{"description":"Received"}}}},"transaction.alert":{"post":{"summary":"transaction.alert","description":"A monitored transaction raised an alert (Growth / Enterprise).\n\nSigned with `AIS-Signature: t=<unix seconds>,v1=<hex HMAC-SHA256 of \"<t>.<raw body>\" with your endpoint secret>`. Reject requests whose t is more than 5 minutes from now. Respond 2xx within 10 seconds; anything else is retried after 1m, 5m, 30m, 2h, 8h and 24h.","parameters":[{"name":"AIS-Signature","in":"header","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TransactionEvent"}}}},"responses":{"200":{"description":"Received"}}}}},"components":{"securitySchemes":{"bearerAuth":{"type":"http","scheme":"bearer","description":"Secret key: ais_live_... or ais_test_..."},"apiKeyHeader":{"type":"apiKey","in":"header","name":"x-api-key","description":"Legacy header, same secret key."},"publishableKey":{"type":"http","scheme":"bearer","description":"Publishable key: ais_pk_live_... or ais_pk_test_..."},"clientToken":{"type":"http","scheme":"bearer","description":"Client token from createVerification: ais_ct_..."}},"parameters":{"VerificationId":{"name":"id","in":"path","required":true,"schema":{"type":"string"}},"CompanyCheckId":{"name":"id","in":"path","required":true,"schema":{"type":"string"}},"IdempotencyKey":{"name":"Idempotency-Key","in":"header","required":false,"schema":{"type":"string","maxLength":255},"description":"Any unique string (a UUID is ideal). Retrying with the same key and body within 24 hours returns the first response."}},"responses":{"BadRequest":{"description":"Invalid request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"Unauthorized":{"description":"Missing or invalid key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"PaymentRequired":{"description":"Not enough credit","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"Forbidden":{"description":"plan_required (API access needs the Growth plan) or origin_not_allowed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"NotFound":{"description":"Not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"Conflict":{"description":"Not possible in the current state, or idempotency conflict","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"TooManyRequests":{"description":"Rate limited","headers":{"Retry-After":{"schema":{"type":"integer"},"description":"Seconds to wait"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"ServerError":{"description":"Server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"schemas":{"ProductStatus":{"type":"string","enum":["pending","in_progress","in_review","completed","failed","expired","canceled"],"description":"failed: could not be processed because of a technical problem (not charged). A completed run is charged whatever its result, except a signing-only signature request the customer declines (one with the ID check is charged for the ID check only)."},"Product":{"type":"object","description":"A signature request, re-verification, age check, address check, document reading or wallet screening (`object` says which).","required":["id","object","livemode","status","result","created_at"],"properties":{"id":{"type":"string"},"object":{"type":"string","enum":["signature_request","reverification","age_check","address_check","document_reading","wallet_screening"]},"livemode":{"type":"boolean"},"status":{"$ref":"#/components/schemas/ProductStatus"},"result":{"type":["string","null"],"description":"signature_request: signed | declined. reverification: match | no_match. age_check: over | under | refer_to_id. address_check: accepted | rejected | review. document_reading: extracted | partial | unreadable. wallet_screening: low | medium | high | critical | unknown."},"reference":{"type":["string","null"]},"metadata":{"$ref":"#/components/schemas/Metadata"},"customer":{"type":"object","additionalProperties":false,"properties":{"name":{"type":"string","maxLength":200},"email":{"type":"string","format":"email"},"phone":{"type":"string","maxLength":32}}},"verification_id":{"type":["string","null"]},"company_check_id":{"type":["string","null"]},"options":{"type":"object","description":"What was requested (threshold, template, chain, with_id_check...)."},"output":{"type":["object","null"],"description":"The result details, in our own vocabulary (see the Developers page for each product)."},"files":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"purpose":{"type":"string","enum":["document","signed","evidence","address_document"]},"file_name":{"type":"string"},"content_type":{"type":"string"},"size":{"type":"integer"},"sha256":{"type":"string"},"url":{"type":"string"}}}},"customer_url":{"type":["string","null"],"description":"The customer's link (our branded page), for products with a customer step."},"redirect_url":{"type":["string","null"]},"charge":{"type":["number","null"],"description":"AUD charged (null until charged)."},"source":{"type":"string","enum":["api","dashboard"]},"created_at":{"type":"integer"},"started_at":{"type":["integer","null"]},"completed_at":{"type":["integer","null"]},"expires_at":{"type":["integer","null"],"description":"Customer links last 7 days."}}},"ProductList":{"type":"object","properties":{"object":{"const":"list"},"url":{"type":"string"},"has_more":{"type":"boolean"},"data":{"type":"array","items":{"$ref":"#/components/schemas/Product"}}}},"CreateSignatureRequest":{"type":"object","additionalProperties":false,"required":["document","customer"],"properties":{"document":{"type":"object","additionalProperties":false,"required":["file_name","content_base64"],"properties":{"file_name":{"type":"string","maxLength":120},"content_base64":{"type":"string","description":"The file, base64 (data: URLs accepted). Max 3 MB decoded."}}},"document_title":{"type":"string","maxLength":120},"customer":{"type":"object","additionalProperties":false,"properties":{"name":{"type":"string","maxLength":200},"email":{"type":"string","format":"email"},"phone":{"type":"string","maxLength":32}},"required":["name"]},"with_id_check":{"type":"boolean","description":"ID check (photo ID, selfie + liveness, AML) before signing."},"level":{"type":"string","enum":["simple","advanced"],"description":"advanced (identity-verified, confirmed with an email code) needs with_id_check."},"reference":{"type":"string","maxLength":200},"metadata":{"$ref":"#/components/schemas/Metadata"},"send_email":{"type":"boolean","description":"Default: true when customer.email is given."},"redirect_url":{"type":"string","format":"uri","description":"https only. Where the customer goes when finished (we add id, status and result)."}}},"CreateAgeCheckRequest":{"type":"object","additionalProperties":false,"properties":{"customer":{"type":"object","additionalProperties":false,"properties":{"name":{"type":"string","maxLength":200},"email":{"type":"string","format":"email"},"phone":{"type":"string","maxLength":32}}},"threshold":{"type":"integer","enum":[18,21,25],"default":18},"fallback_to_id":{"type":"boolean","default":true},"reference":{"type":"string","maxLength":200},"metadata":{"$ref":"#/components/schemas/Metadata"},"send_email":{"type":"boolean","description":"Default: true when customer.email is given."},"redirect_url":{"type":"string","format":"uri","description":"https only. Where the customer goes when finished (we add id, status and result)."}}},"CreateAddressCheckRequest":{"type":"object","additionalProperties":false,"properties":{"customer":{"type":"object","additionalProperties":false,"properties":{"name":{"type":"string","maxLength":200},"email":{"type":"string","format":"email"},"phone":{"type":"string","maxLength":32}}},"verification_id":{"type":"string","description":"Compare with this verified ID name."},"document":{"type":"object","additionalProperties":false,"required":["file_name","content_base64"],"properties":{"file_name":{"type":"string","maxLength":120},"content_base64":{"type":"string","description":"The file, base64 (data: URLs accepted). Max 3 MB decoded."}}},"max_age_days":{"type":"integer","minimum":1,"maximum":365,"default":90},"reference":{"type":"string","maxLength":200},"metadata":{"$ref":"#/components/schemas/Metadata"},"send_email":{"type":"boolean","description":"Default: true when customer.email is given."},"redirect_url":{"type":"string","format":"uri","description":"https only. Where the customer goes when finished (we add id, status and result)."}}},"CreateDocumentRequest":{"type":"object","additionalProperties":false,"required":["document","template"],"properties":{"document":{"type":"object","additionalProperties":false,"required":["file_name","content_base64"],"properties":{"file_name":{"type":"string","maxLength":120},"content_base64":{"type":"string","description":"The file, base64 (data: URLs accepted). Max 3 MB decoded."}}},"template":{"type":"string","enum":["trust_deed","rates_notice","company_extract","custom"]},"fields":{"type":"array","maxItems":30,"items":{"type":"object","additionalProperties":false,"required":["key","name","instruction"],"properties":{"key":{"type":"string","pattern":"^[a-z0-9_]{1,40}$"},"name":{"type":"string"},"instruction":{"type":"string"},"type":{"type":"string","enum":["text","number","date"]},"required":{"type":"boolean"}}}},"company_check_id":{"type":"string","description":"Included (free) with this company check."},"verification_id":{"type":"string"},"reference":{"type":"string","maxLength":200},"metadata":{"$ref":"#/components/schemas/Metadata"}}},"CreateWalletScreeningRequest":{"type":"object","additionalProperties":false,"required":["chain","address"],"properties":{"chain":{"type":"string","enum":["BTC","ETH","LTC","XRP","BCH","DOGE","TRX","SOL","MATIC","BNB","BASE","OP","ARB","AVAX","ADA","XLM","HBAR"]},"address":{"type":"string","minLength":20,"maxLength":120},"verification_id":{"type":"string"},"reference":{"type":"string","maxLength":200},"metadata":{"$ref":"#/components/schemas/Metadata"}}},"ReverifyRequest":{"type":"object","additionalProperties":false,"properties":{"reference":{"type":"string","maxLength":200},"metadata":{"$ref":"#/components/schemas/Metadata"},"send_email":{"type":"boolean","description":"Default: true when customer.email is given."},"redirect_url":{"type":"string","format":"uri","description":"https only. Where the customer goes when finished (we add id, status and result)."}}},"CreateTransactionRequest":{"type":"object","additionalProperties":false,"required":["transaction_id","amount","currency","direction"],"properties":{"transaction_id":{"type":"string","maxLength":100,"description":"Your unique id for this transaction."},"amount":{"type":"number","exclusiveMinimum":0},"currency":{"type":"string","examples":["AUD"]},"direction":{"type":"string","enum":["inbound","outbound"]},"occurred_at":{"oneOf":[{"type":"integer"},{"type":"string","format":"date-time"}]},"verification_id":{"type":"string","description":"The verified customer this transaction belongs to."},"subject":{"type":"object","additionalProperties":false,"properties":{"name":{"type":"string"},"account":{"type":"string"},"country":{"type":"string","description":"ISO 3166-1 alpha-2"}}},"counterparty":{"type":"object","additionalProperties":false,"properties":{"name":{"type":"string"},"account":{"type":"string"},"country":{"type":"string"},"type":{"type":"string","enum":["person","company"]}}},"reference":{"type":"string","maxLength":200},"metadata":{"$ref":"#/components/schemas/Metadata"}}},"Transaction":{"type":"object","properties":{"id":{"type":"string"},"object":{"const":"transaction"},"livemode":{"type":"boolean"},"transaction_id":{"type":"string"},"amount":{"type":"number"},"currency":{"type":"string"},"direction":{"type":"string"},"occurred_at":{"type":["integer","null"]},"verification_id":{"type":["string","null"]},"status":{"type":"string","enum":["approved","in_review","declined"]},"score":{"type":["number","null"]},"alerts":{"type":"array","items":{"type":"object","properties":{"rule":{"type":"string"},"action":{"type":["string","null"]},"description":{"type":["string","null"]}}}},"alert_status":{"type":"string","enum":["none","open","resolved"]},"resolved_at":{"type":["integer","null"]},"resolution_note":{"type":["string","null"]},"charge":{"type":["number","null"]},"created_at":{"type":"integer"}}},"AddOns":{"type":"object","description":"Add-ons on the verification link.","properties":{"source_of_funds":{"type":"object","properties":{"enabled":{"type":"boolean"},"completed_at":{"type":["integer","null"]},"answers":{"type":["object","null"],"additionalProperties":{"type":"string"},"description":"occupation, source_of_funds(_detail), source_of_wealth(_detail), purpose, expected_value, pep (yes|no), pep_detail"}}},"phone":{"type":"object","properties":{"requested":{"type":"boolean"},"verified":{"type":"boolean"},"verified_at":{"type":["integer","null"]},"number":{"type":["string","null"]}}},"email":{"type":"object","properties":{"requested":{"type":"boolean"},"verified":{"type":"boolean"},"verified_at":{"type":["integer","null"]},"address":{"type":["string","null"]}}},"fraud_check":{"type":"object","properties":{"enabled":{"type":"boolean"},"status":{"type":"string","enum":["off","pending","clear","flagged","error"]},"flags":{"type":"array","items":{"type":"string","enum":["duplicate_identity","blocklisted","same_person_before"]}},"matches":{"type":"array","items":{"type":"object","properties":{"verification_id":{"type":"string"},"similarity":{"type":["number","null"]},"name_matches":{"type":["boolean","null"]},"blocked":{"type":"boolean"}}}}}}}},"VerificationOptions":{"type":"object","additionalProperties":false,"properties":{"source_of_funds":{"type":"boolean","description":"Source-of-funds / CDD questionnaire before the ID check. Free."},"verify_phone":{"type":"boolean","description":"One-time code to the customer's mobile. Free."},"verify_email":{"type":"boolean","description":"One-time code to the customer's email. Free."},"fraud_check":{"type":"boolean","description":"Duplicate / fraud detection within your account when approved. $0.99."}}},"ProductEvent":{"type":"object","required":["id","object","type","created","livemode","data"],"properties":{"id":{"type":"string"},"object":{"const":"event"},"type":{"type":"string"},"created":{"type":"integer"},"livemode":{"type":"boolean"},"data":{"type":"object","properties":{"object":{"$ref":"#/components/schemas/Product"}}}}},"TransactionEvent":{"type":"object","required":["id","object","type","created","livemode","data"],"properties":{"id":{"type":"string"},"object":{"const":"event"},"type":{"const":"transaction.alert"},"created":{"type":"integer"},"livemode":{"type":"boolean"},"data":{"type":"object","properties":{"object":{"$ref":"#/components/schemas/Transaction"}}}}},"Error":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["type","code","message"],"properties":{"type":{"type":"string","enum":["invalid_request_error","authentication_error","permission_error","billing_error","idempotency_error","rate_limit_error","api_error"]},"code":{"type":"string","examples":["parameter_invalid","invalid_api_key","plan_required","insufficient_credit","rate_limited","resource_missing"]},"message":{"type":"string"},"param":{"type":"string"}}}}},"VerificationStatus":{"type":"string","enum":["pending","in_progress","in_review","completed","expired","abandoned","canceled"],"description":"pending: created, not opened. in_progress: customer started. in_review: waiting for your review (approve or decline it in the dashboard), a result follows. completed: finished (see result). expired/abandoned/canceled: ended without a result, not charged."},"CheckStatus":{"type":"string","enum":["passed","failed","review","not_run"]},"Metadata":{"type":"object","additionalProperties":{"type":"string","maxLength":500},"maxProperties":20,"description":"Up to 20 string key/values. Keys up to 40 characters (letters, digits, _ . - :), values up to 500, 4 KB in total."},"CreateVerificationRequest":{"type":"object","additionalProperties":false,"properties":{"customer":{"type":"object","additionalProperties":false,"properties":{"email":{"type":"string","format":"email","maxLength":254},"name":{"type":"string","maxLength":200},"phone":{"type":"string","maxLength":32,"examples":["+61400000000"]}}},"reference":{"type":"string","maxLength":200,"description":"Your own id for this check (order, customer or case number)."},"metadata":{"$ref":"#/components/schemas/Metadata"},"send_email":{"type":"boolean","description":"Default: true when customer.email is given."},"redirect_url":{"type":"string","format":"uri","description":"https only. Where we send the customer after they finish (we add verification_id, status and result)."},"options":{"$ref":"#/components/schemas/VerificationOptions"}}},"Verification":{"type":"object","required":["id","object","livemode","status","result","verification_url","created_at","expires_at"],"properties":{"id":{"type":"string"},"object":{"const":"verification"},"livemode":{"type":"boolean"},"status":{"$ref":"#/components/schemas/VerificationStatus"},"result":{"type":["string","null"],"enum":["approved","declined",null]},"reference":{"type":["string","null"]},"metadata":{"$ref":"#/components/schemas/Metadata"},"customer":{"type":"object","properties":{"email":{"type":["string","null"]},"name":{"type":["string","null"]},"phone":{"type":["string","null"]}}},"document":{"type":["object","null"],"description":"Present once the check has run.","properties":{"type":{"type":["string","null"],"enum":["passport","driving_licence","id_card","residence_permit","other",null]},"country":{"type":["string","null"],"examples":["Australia"]},"country_code":{"type":["string","null"],"description":"ISO 3166-1 alpha-3","examples":["AUS"]}}},"checks":{"type":["object","null"],"description":"Present once the check has run.","properties":{"document":{"type":"object","properties":{"status":{"type":"string","enum":["passed","failed","review","not_run"]}}},"face_match":{"type":"object","properties":{"status":{"type":"string","enum":["passed","failed","review","not_run"]},"score":{"type":["number","null"],"description":"Similarity 0-100"}}},"liveness":{"type":"object","properties":{"status":{"type":"string","enum":["passed","failed","review","not_run"]}}},"aml":{"type":"object","properties":{"status":{"type":"string","enum":["passed","failed","review","not_run"]},"hits":{"type":["integer","null"]}}}}},"verification_url":{"type":"string","format":"uri","description":"The customer link (our branded page)."},"redirect_url":{"type":["string","null"]},"report_url":{"type":["string","null"],"description":"PDF report (needs your secret key), once completed."},"source":{"type":"string","enum":["api","sdk","widget","dashboard","company_check","zapier"]},"company_check_id":{"type":["string","null"],"description":"Set when this is a director / beneficial owner check of a company check."},"monitoring":{"$ref":"#/components/schemas/Monitoring"},"add_ons":{"$ref":"#/components/schemas/AddOns"},"created_at":{"type":"integer","description":"Unix seconds"},"started_at":{"type":["integer","null"]},"completed_at":{"type":["integer","null"]},"expires_at":{"type":"integer","description":"Unix seconds; links last 7 days"}}},"Monitoring":{"type":"object","description":"Ongoing AML monitoring of this person.","properties":{"enabled":{"type":"boolean"},"status":{"type":"string","enum":["off","active","alert"],"description":"alert: a new or changed match since monitoring started (or since the last alert)."},"enabled_at":{"type":["integer","null"]},"paid_until":{"type":["integer","null"],"description":"End of the current monitoring year (renews then)."},"last_alert_at":{"type":["integer","null"]},"alert_count":{"type":"integer"},"alert":{"type":["object","null"],"properties":{"aml_status":{"type":"string","enum":["passed","failed","review","not_run"]},"hits":{"type":["integer","null"]}}}}},"CreateCompanyCheckRequest":{"type":"object","additionalProperties":false,"required":["company"],"properties":{"company":{"type":"object","additionalProperties":false,"properties":{"name":{"type":"string","maxLength":200},"abn":{"type":"string","description":"11-digit ABN (spaces allowed, checksum validated)","examples":["51 824 753 556"]},"acn":{"type":"string","description":"9-digit ACN (checksum validated)"}}},"contact":{"type":"object","additionalProperties":false,"properties":{"email":{"type":"string","format":"email","maxLength":254},"name":{"type":"string","maxLength":200}},"description":"The person at the business who completes the check."},"reference":{"type":"string","maxLength":200},"metadata":{"$ref":"#/components/schemas/Metadata"},"send_email":{"type":"boolean","description":"Default: true when contact.email is given."},"redirect_url":{"type":"string","format":"uri","description":"https only. Where the contact goes when finished (we add company_check_id, status and result)."}}},"CompanyPerson":{"type":"object","properties":{"id":{"type":"string"},"role":{"type":"string","enum":["director","beneficial_owner","shareholder","officer","representative","other"]},"roles":{"type":"array","items":{"type":"string"}},"name":{"type":"string"},"email":{"type":["string","null"]},"ownership":{"type":["number","null"],"description":"Ownership percent, when declared"},"verification_id":{"type":["string","null"],"description":"Their identity verification (GET /api/v1/verifications/{id})"},"status":{"$ref":"#/components/schemas/VerificationStatus"},"result":{"type":["string","null"],"enum":["approved","declined",null]},"included_in_price":{"type":"boolean","description":"This person's check is covered by the company check price."}}},"CompanyCheck":{"type":"object","required":["id","object","livemode","status","result","company","people","verification_url","created_at"],"properties":{"id":{"type":"string"},"object":{"const":"company_check"},"livemode":{"type":"boolean"},"status":{"$ref":"#/components/schemas/VerificationStatus"},"result":{"type":["string","null"],"enum":["approved","declined",null],"description":"The company's own result (registry + company AML + declaration)."},"overall_result":{"type":["string","null"],"enum":["approved","declined","pending_people",null],"description":"approved only when the company and every person are approved; declined if any is declined; pending_people while people checks are open."},"reference":{"type":["string","null"]},"metadata":{"$ref":"#/components/schemas/Metadata"},"contact":{"type":"object","properties":{"email":{"type":["string","null"]},"name":{"type":["string","null"]}}},"company":{"type":"object","properties":{"name":{"type":["string","null"]},"abn":{"type":["string","null"],"description":"11 digits"},"acn":{"type":["string","null"],"description":"9 digits"},"status":{"type":"string","enum":["active","deregistered","inactive","unknown"]},"type":{"type":["string","null"],"enum":["company","trust","partnership","sole_trader","government","other",null]},"type_description":{"type":["string","null"],"examples":["Australian Private Company"]},"address":{"type":["string","null"]},"incorporation_date":{"type":["string","null"]}}},"abn_lookup":{"type":["object","null"],"description":"Australian Business Register (ABN Lookup) result, when an ABN/ACN was checked.","properties":{"abn_status":{"type":"string","enum":["active","cancelled","unknown"]},"abn_status_from":{"type":["string","null"]},"entity_name":{"type":["string","null"]},"entity_type":{"type":["string","null"]},"gst_registered":{"type":"boolean"},"gst_registered_from":{"type":["string","null"]},"checked_at":{"type":"integer"}}},"checks":{"type":["object","null"],"description":"Present once the check has run.","properties":{"registry":{"type":"object","properties":{"status":{"type":"string","enum":["passed","failed","review","not_run"]}}},"company_aml":{"type":"object","properties":{"status":{"type":"string","enum":["passed","failed","review","not_run"]},"hits":{"type":["integer","null"]}}}}},"people":{"type":"array","items":{"$ref":"#/components/schemas/CompanyPerson"}},"verification_url":{"type":"string","format":"uri","description":"The contact's link (our branded page)."},"redirect_url":{"type":["string","null"]},"report_url":{"type":["string","null"]},"source":{"type":"string","enum":["api","dashboard","zapier"]},"created_at":{"type":"integer"},"started_at":{"type":["integer","null"]},"completed_at":{"type":["integer","null"]},"expires_at":{"type":"integer"}}},"CompanyCheckList":{"type":"object","properties":{"object":{"const":"list"},"url":{"type":"string"},"has_more":{"type":"boolean"},"data":{"type":"array","items":{"$ref":"#/components/schemas/CompanyCheck"}}}},"CompanyCheckEvent":{"type":"object","required":["id","object","type","created","livemode","data"],"properties":{"id":{"type":"string"},"object":{"const":"event"},"type":{"type":"string","enum":["company_check.created","company_check.completed","company_check.failed","company_check.expired"]},"created":{"type":"integer"},"livemode":{"type":"boolean"},"data":{"type":"object","properties":{"object":{"$ref":"#/components/schemas/CompanyCheck"}}}}},"VerificationWithClientToken":{"allOf":[{"$ref":"#/components/schemas/Verification"},{"type":"object","properties":{"client_token":{"type":"string","description":"For the front-end SDK. Valid 1 hour, for this check only."},"client_token_expires_at":{"type":"integer"}}}]},"VerificationList":{"type":"object","properties":{"object":{"const":"list"},"url":{"type":"string"},"has_more":{"type":"boolean"},"data":{"type":"array","items":{"$ref":"#/components/schemas/Verification"}}}},"ClientToken":{"type":"object","properties":{"object":{"const":"client_token"},"verification":{"type":"string"},"client_token":{"type":"string"},"expires_at":{"type":"integer"}}},"Account":{"type":"object","properties":{"object":{"const":"account"},"id":{"type":"string"},"name":{"type":"string"},"livemode":{"type":"boolean"},"plan":{"type":"string","enum":["payg","business","enterprise"]},"currency":{"const":"aud"},"credit_balance":{"type":"number"},"price_per_check":{"type":"number","description":"What your next completed check costs (0 while included checks remain)."},"included_checks":{"type":["object","null"],"properties":{"per_month":{"type":"integer"},"used":{"type":"integer"},"remaining":{"type":"integer"}}}}},"SdkCreateRequest":{"type":"object","additionalProperties":false,"properties":{"reference":{"type":"string","maxLength":200},"metadata":{"$ref":"#/components/schemas/Metadata"},"mode":{"type":"string","enum":["inline","modal","redirect"],"default":"inline","description":"inline / modal embed the check in your page and need your site in Allowed domains (else 403 origin_not_allowed, and no check is created). redirect: open verification_url instead."}}},"SdkVerification":{"type":"object","properties":{"id":{"type":"string"},"object":{"const":"verification"},"livemode":{"type":"boolean"},"status":{"$ref":"#/components/schemas/VerificationStatus"},"result":{"type":["string","null"],"enum":["approved","declined",null]},"reference":{"type":["string","null"]},"verification_url":{"type":"string"},"client_token":{"type":"string"},"client_token_expires_at":{"type":"integer"},"embeddable":{"type":"boolean","description":"Whether the calling website is in Allowed domains (needed for inline/modal)."}}},"Event":{"type":"object","required":["id","object","type","created","livemode","data"],"properties":{"id":{"type":"string","examples":["evt_3f2a..."]},"object":{"const":"event"},"type":{"type":"string","enum":["verification.created","verification.started","verification.review","verification.completed","verification.failed","verification.expired","verification.canceled","verification.monitoring_alert","verification.fraud_flag"]},"created":{"type":"integer"},"livemode":{"type":"boolean"},"data":{"type":"object","properties":{"object":{"$ref":"#/components/schemas/Verification"}}}}}}}}