KYC-sager

List KYC-sager

GET /api/v1/kyc/cases

Hent en pagineret liste over KYC-sager.

Scope: kyc:read · Brugerrettighed: kyc_cases_view

Query parametre

Parameter	Type	Standard	Beskrivelse
page	integer	1	Sidetal
page_size	integer	25	Resultater pr. side (1-100)
status	string	—	Filtrer på status (DRAFT, IN_PROGRESS, PENDING_REVIEW, REVIEWED, PENDING_DOCUMENTS, COMPLETED, ARCHIVED)
year	string	—	Filtrer på regnskabsår (f.eks. "2025")

Sagerne sorteres efter oprettelse, nyeste først.

Response-felter

Felt	Type	Beskrivelse
id	integer	Sagens ID
case_number	string	Sagsnummer
year	string	Regnskabsår
status	string	Sagens status
client	object	Kunden
client.name	string	Kundens navn
client.cvr	string | null	CVR-nummer
client.type	string	COMPANY eller INDIVIDUAL
client.address	string | null	Adresse
risk_level	string | null	Samlet risikoniveau (NONE, LIMITED, MODERATE, SIGNIFICANT eller HIGH), samme værdi som i Auditply. null, indtil sagen er afsluttet
persons_count	integer	Antal personer på sagen
files_count	integer	Antal filer på sagen (slettede tælles ikke med)
created_at	string	Oprettelsesdato
completed_at	string | null	Afslutningsdato

Eksempel

curl

curl "https://auditply.dk/api/v1/kyc/cases?status=COMPLETED&year=2025" \
  -H "X-API-Key: ap_live_..." \
  -H "X-On-Behalf-Of-User: 42"

JavaScript

const res = await fetch(
  "https://auditply.dk/api/v1/kyc/cases?status=COMPLETED",
  { headers: { "X-API-Key": apiKey, "X-On-Behalf-Of-User": "42" } }
);
const { data, pagination } = await res.json();

Python

response = requests.get(
    "https://auditply.dk/api/v1/kyc/cases",
    headers={"X-API-Key": api_key, "X-On-Behalf-Of-User": "42"},
    params={"status": "COMPLETED", "year": "2025"}
)

Response — 200 OK

{
  "data": [
    {
      "id": 42,
      "case_number": "KYC-2025-0001",
      "year": "2025",
      "status": "COMPLETED",
      "client": {
        "name": "Eksempel Holding ApS",
        "cvr": "12345678",
        "type": "COMPANY",
        "address": "Vestergade 1, 1000 København"
      },
      "risk_level": "MODERATE",
      "persons_count": 3,
      "files_count": 7,
      "created_at": "2025-01-10T09:00:00.000Z",
      "completed_at": "2025-03-15T14:30:00.000Z"
    }
  ],
  "pagination": {
    "page": 1,
    "page_size": 25,
    "total_count": 1,
    "total_pages": 1,
    "has_more": false
  }
}

---

Hent KYC-sag

GET /api/v1/kyc/cases/:id

Hent detaljer for en specifik KYC-sag inklusiv personer, risikovurdering og filer.

Scope: kyc:read · Brugerrettighed: kyc_cases_view

Path parametre

Parameter	Type	Beskrivelse
id	integer	KYC-sagens ID

Response-felter

Felt	Type	Beskrivelse
id	integer	Sagens ID
case_number	string	Sagsnummer
year	string	Regnskabsår
status	string	Sagens status
client	object	Kunden: name, cvr, type, address og industry_code (branchekode)
risk	object | null	Risikovurderingen: customer, product, geography, overall, justification og assessed_at (se nedenfor)
risk_justification	string | null	Revisorens begrundelse for risikoen
persons	array	Personer på sagen: id, name, role, email
files	array	Filer på sagen: id, name, type, uploaded_at. Slettede filer er ikke med
services	array	Ydelseskoder
countries	array	Lande: code, is_domicile, is_activity
created_at	string	Oprettelsesdato
updated_at	string	Seneste ændring
completed_at	string | null	Afslutningsdato
reviewed_at	string | null	Review-tidspunkt

risk.overall er sagens samlede risikoniveau (NONE, LIMITED, MODERATE, SIGNIFICANT eller HIGH), samme værdi som i Auditply og i status for KYC-sag. Det er null, indtil sagen er afsluttet. customer, product, geography, justification og assessed_at kommer fra sagens seneste risikovurdering. En sag får en foreløbig vurdering, når den oprettes, så risk er sjældent null, og assessed_at er null, indtil revisoren har vurderet risikoen.

Sagens KYC-ansvarlige og revisoren, der godkendte sagen, står i status for KYC-sag (kyc_responsible og assessment.assessed_by).

Findes sagen ikke, eller tilhører den en anden virksomhed, svarer endpointet 404 med RESOURCE_NOT_FOUND.

Response — 200 OK

{
  "data": {
    "id": 42,
    "case_number": "KYC-2025-0001",
    "year": "2025",
    "status": "COMPLETED",
    "client": {
      "name": "Eksempel Holding ApS",
      "cvr": "12345678",
      "type": "COMPANY",
      "address": "Vestergade 1, 1000 København",
      "industry_code": "69.20"
    },
    "risk": {
      "customer": "MEDIUM",
      "product": "LOW",
      "geography": "LOW",
      "overall": "MODERATE",
      "justification": "…",
      "assessed_at": "2025-03-15T14:00:00.000Z"
    },
    "risk_justification": "…",
    "persons": [
      { "id": 7, "name": "Jens Jensen", "role": "reel_ejer", "email": "jens@eksempel.dk" }
    ],
    "files": [
      { "id": 301, "name": "pep-erklaering.pdf", "type": "pep_declaration", "uploaded_at": "2025-02-01T10:00:00.000Z" }
    ],
    "services": ["1A"],
    "countries": [
      { "code": "DK", "is_domicile": true, "is_activity": true }
    ],
    "created_at": "2025-01-10T09:00:00.000Z",
    "updated_at": "2025-03-15T14:30:00.000Z",
    "completed_at": "2025-03-15T14:30:00.000Z",
    "reviewed_at": "2025-03-15T14:20:00.000Z"
  }
}