Hop til hovedindhold

Legitimation på person

PUT /api/v1/kyc/cases/:case_key/persons/:person_key/documents/:document_kind

Uploader en persons legitimation, eller erstatter den, der ligger. Kaldet kan gentages sikkert: samme fil igen ændrer intet.

Scope: kyc:documents · Brugerrettighed: kyc_cases_edit

:case_key og :person_key har samme former som ved opret eller opdatér person.

:document_kind er én af passport, driving_licence, health_card og other_legitimation.

Request body​

multipart/form-data:

FeltTypeBeskrivelse
filefilPåkrævet. JPEG, PNG, GIF, WebP eller PDF; højst 10 MB. Filens Content-Type skal være en af typerne. Billeder komprimeres, som når kunden selv uploader
sha256hex (64 tegn)Valgfri. SHA-256 af filen, som I sender den. Passer den ikke, afvises kaldet
expiry_dateYYYY-MM-DDPåkrævet for passport og driving_licence
uploaded_bycustomer | advisorValgfri. Vises for revisoren, fx "Velas-integration – uploadet af kunden"

Hvert felt må kun sendes én gang, og ukendte felter afvises.

Hvad sker der​

  • Filen gemmes på personen, som hvis revisoren havde uploadet den i Auditply "på vegne af" personen.
  • Samme fil igen (samme SHA-256 og udløbsdato) ændrer intet. Svaret er 200 med den eksisterende fil.
  • En ny fil erstatter alle aktive filer af samme type for personen — også filer, kunden eller revisoren har lagt op i Auditply. De erstattede filer slettes som i Auditply og fjernes endeligt efter 30 dage.

Svar 201 (første fil på pladsen) eller 200 (erstatning eller ingen ændring):

{ "data": { "document_id": 9076, "replaced_document_ids": [9075] } }

Filer kan ændres, når sagen er DRAFT, IN_PROGRESS eller PENDING_DOCUMENTS og ikke er deaktiveret. Et kald, der ikke ændrer noget, lykkes også på en låst sag.

Fejl​

KodeHTTPÅrsag
PERSON_NOT_FOUND404Personen findes ikke på sagen
CASE_NOT_FOUND404Sagen findes ikke
CASE_NOT_EDITABLE409Sagen er låst (review, afsluttet, arkiveret eller deaktiveret)
CHECKSUM_MISMATCH422sha256 passer ikke til filen; details.received_sha256 er den, vi beregnede
FILE_TOO_LARGE413Filen er større end 10 MB
UNSUPPORTED_MEDIA_TYPE415Filtypen er ikke tilladt
VALIDATION_ERROR400Ukendt document_kind, manglende file eller expiry_date, eller en body, der ikke er multipart/form-data

Eksempel​

curl -X PUT https://auditply.dk/api/v1/kyc/cases/cvr:12345678/persons/ref:person-84a1/documents/passport \
-H "X-API-Key: ap_live_..." \
-H "X-On-Behalf-Of-User: 42" \
-F "file=@pas.pdf;type=application/pdf" \
-F "expiry_date=2030-01-31" \
-F "uploaded_by=customer"