KYC / KYB API

HTTP-first FastAPI service. Prefer OpenAPI reference or live /docs for schemas.

Base URL

Local default: http://localhost:8000 (poetry run uvicorn src.app:app --reload).

Endpoint map (static OpenAPI)

Tag	Paths
Monitoring	GET /health
ID	POST /prembly_id_check, POST /id_check/all
Business	POST /prembly_business_check
Address	POST /prembly_address_check
Documents	POST /prembly_doc_check, POST /doc_extract, POST /doc_check/all
Biodata	POST /biodata_check
Report / risk	POST /generate_report, POST /calculate_customer_risk_profile
Screening	POST /find_person, POST /open_sanction_finder, POST /pep_and_sanction_checker, POST /adverse_media_screener
Biometrics	POST /liveliness_check, POST /face_comparison, POST /face_comparison/id_images, POST /edt/liveliness_check

Integration tips

1. GET /health first.
2. Common onboarding chain: ID/doc → liveliness/face → screening → risk/report.
3. Multipart / image fields: copy names from Swagger — do not guess.
4. Keep Prembly and GCP secrets server-side.
5. After route changes, refresh docs/openapi/kyc-kyb.openapi.json (see platform-docs/README.md).

goAML

src/report/aml_goaml/ builds NFIU goAML XML from Excel/JSON. No FastAPI route currently exposes it — integrate only if you run that library/pipeline offline (PARTIAL).

Auth

No JWT dependency on these routes in app.py. Confirm environment gateway requirements with owners (Auth and tenancy).