Document Verify

Verifies the authenticity of a document for an enterprise user by uploading a PDF file or providing its document code. Returns the verification status and related information.

HTTP Method and URL

POST {{host}}/api/v2/verifications/document/verify?user_type=ENTERPRISE_API

Authentication Requirements

Requires a valid authentication token. Set the user-token variable in your environment or request headers.

Query Parameters

• user_type (string, required): Must be set to ENTERPRISE_API.

Request Body

Content-Type: multipart/form-data

• file (file, optional): The PDF file to verify.

• code (string, optional): The document code (can be retrieved from DOC Vault).

• user_uuid (string, required): The UUID of the user.

At least one of file or code must be provided.

Example Request

curl -X POST "{{host}}/api/v2/verifications/document/verify?user_type=ENTERPRISE_API" \
  -H "Authorization: Bearer <user-token>" \
  -F "file=@/path/to/document.pdf" \
  -F "code=DCMMKVRK737H6H" \
  -F "user_uuid=AsnF5ZxOafTuCT2"

Example Successful Response

{
  "status": "verified",
  "document": {
    "code": "DCMMKVRK737H6H",
    "user_uuid": "AsnF5ZxOafTuCT2",
    "verified_at": "2024-06-01T12:34:56Z"
  },
  "message": "Document successfully verified."
}

Error Responses

• 400 Bad Request: Missing required parameters or invalid input.

• 401 Unauthorized: Authentication failed or missing token.

• 404 Not Found: Document not found.

• 422 Unprocessable Entity: Document could not be verified.

Usage Notes

• Either file or code must be provided in the request body.

• Ensure the user-token variable is set in your environment for authentication.

• The endpoint returns verification status and additional document details if successful.