Opret eller opdatér KYC-sag

PUT /api/v1/kyc/cases/:case_key

Opretter en KYC-sag for en kunde, eller opdaterer den eksisterende. Kaldet kan gentages sikkert: samme kald to gange giver ikke to sager.

Scope: kyc:write · Brugerrettighed: kyc_cases_create og kyc_meetings_create (skift af ansvarlig på en eksisterende sag kræver desuden kyc_cases_assign)

Sagsnøgle

Form	Eksempel	Bruges til
cvr:{cvr}	cvr:12345678	Virksomhedskunder. Påkrævet for at oprette en ny virksomhedskunde
ref:{external_reference}	ref:6f1c-ab	Personkunder, og eksisterende kunder med en reference
{case_id}	4213	En eksisterende sag

cvr: og ref: peger på kundens aktuelle sag — den nyeste, der ikke er deaktiveret. Laver revisoren en revurdering i Auditply, bliver den nye sag automatisk den aktuelle. Har kunden kun deaktiverede sager, opretter dette endpoint en ny sag, mens de øvrige endpoints (status, ansvarlig, personer og dokumenter) finder den nyeste deaktiverede sag. Ændringer på den giver CASE_NOT_EDITABLE; et kald, der ikke ændrer noget, lykkes.

Request body

Felt	Type	Beskrivelse
customer_type	company | person	Påkrævet
external_reference	string	Påkrævet. Jeres eget kunde-id (1–255 tegn). Gemmes på kunden og returneres i alle svar
kyc_responsible	{ "user_id": 42 } eller { "email": "…" }	Påkrævet ved oprettelse. Den KYC-ansvarlige rådgiver i Auditply
name	string	Kun person: påkrævet ved oprettelse
address	string	Kun person: valgfri
date_of_birth	YYYY-MM-DD	Kun person: valgfri
unit_number	string	Kun person: valgfri. Enhedsnummer, hvis CVR-registret kender personen (1–15 cifre; foranstillede nuller fjernes). Personen kan derefter adresseres med unit: i person-endpointet

Virksomheders stamdata, ejere og ledelse slår Auditply selv op i CVR — de sendes ikke. Ukendte felter afvises, og CPR modtages ikke.

Hvad sker der

• Ny sag: Auditply opretter kunden med CVR-data, starter et møde og opretter sagen med status DRAFT og de første personer fra CVR. Svaret er 201.
• Eksisterende sag: Den ansvarlige opdateres, hvis den er ændret. Svaret er 200. Det gælder også en afsluttet sag — der oprettes aldrig automatisk en revurdering.
• Afsluttet kundeforhold: Har kunden kun deaktiverede sager, oprettes en ny sag (201), fordi kaldet genoptager kundeforholdet. Tjek deactivated_at i status først, hvis I ikke vil det.
• Kunde oprettet i Auditply: En virksomhedskunde findes via cvr:, og referencen gemmes på den ved første kald. En personkunde, som revisoren har oprettet i Auditply, har ingen reference og kan ikke findes med ref: — et kald med ref: opretter en ny kunde ved siden af. Kobl den i stedet én gang ved at kalde med sagens case_id (fx fra listen over KYC-sager) og jeres external_reference. Derefter virker ref:.

Revisoren gennemfører fortsat mødet, vælger dokumentkrav og laver vurderingen i Auditply. Svaret er status-objektet. Gem altid case_id fra svaret, da det skifter ved en revurdering.

Fejl

Kode	HTTP	Årsag
CVR_NOT_FOUND	404	CVR-nummeret findes ikke i CVR-registret
CVR_LOOKUP_FAILED	502	CVR-opslaget fejlede; kaldet kan gentages
EXTERNAL_REFERENCE_CONFLICT	409	Kunden har allerede en anden reference, eller referencen bruges af en anden kunde
USER_NOT_FOUND	404	Den ansvarlige findes ikke i virksomheden
CASE_NOT_FOUND	404	Et case_id findes ikke
CASE_NOT_EDITABLE	409	Skift af ansvarlig på en arkiveret eller deaktiveret sag
VALIDATION_ERROR	400	Ugyldig nøgle eller body, fx cvr: med customer_type: person

Eksempel

curl -X PUT https://auditply.dk/api/v1/kyc/cases/cvr:12345678 \
  -H "X-API-Key: ap_live_..." \
  -H "X-On-Behalf-Of-User: 42" \
  -H "Content-Type: application/json" \
  -d '{
    "customer_type": "company",
    "external_reference": "6f1c-ab",
    "kyc_responsible": { "email": "raadgiver@example.dk" }
  }'