Skip to navigation
Vlens APIFRA Services

PII inquiry: submit the ID card as one PDF

View as Markdown

Same PII inquiry as POST /api/FRAServices/PersonallyIdentifiableInformation, but the national ID is uploaded as one PDF file that contains both the front and the back, instead of two base64 images.

The request is multipart/form-data. The file must be a real PDF (not another file renamed to .pdf) and at most 5 MB. The front and back are read from the PDF and saved as the usual ID front and ID back steps, so the response has the same shape as the image variant.

OTP is optional: to prove phone-number ownership, call POST /api/FRAServices/RequestOtpForPii first and send otpRequestId and otpCode together. Send both or neither.

Authentication

ApiKeystring
Static API key issued to your tenant. Required on every request.
OR
AuthorizationBearer

End-user JWT from registration or login. Required for verification, signing, and user-scoped operations.

Request

This endpoint expects a multipart form containing a file.
filefileRequired
One PDF with the front and the back of the national ID. Real PDF content only, at most 5 MB.
phoneNumberstringRequired
The phone number being validated.
otpRequestIdstringOptionalformat: "uuid"

Optional. The otpRequestId returned by POST /api/FRAServices/RequestOtpForPii. Send together with otpCode.

otpCodestringOptional

Optional. The OTP the user received. Send together with otpRequestId.

transactionIdstringOptionalformat: "uuid"
Optional. An existing transaction ID.
bypassSpoofingCheckbooleanOptionalDefaults to false

Optional. Defaults to false. Set it to true to skip the spoofing check on the ID pages read from the PDF, so a scanned or printed copy is not rejected as a forged document (5005). Every other document check still runs.

Response

PII inquiry result.
dataobjectOptional
error_codeinteger or nullOptional
error_messagestring or nullOptional
error_descriptionslist of strings or nullOptional

Errors

400
Bad Request Error