Upload File

POST 
/utility/api/1.0/files

Upload File

Request

Query Parameters

fileCategory stringrequired
Possible values: [bgv-tenth, bgv-twelfth, bgv-degree, bgv-employment, bgv-criminal, bgv-police-verification, bgv-police-clearance-certificate, bgv-cibil, bgv-local-address-digital, bgv-local-address-postal, bgv-permanent-address-digital, bgv-permanent-address-postal]
The background check category the file belongs to.
Example: bgv-twelfth

multipart/form-data

Body

required

file binaryrequired

The file to upload (PDF or image)

Responses

200

File uploaded successfully

application/json

Schema

Schema

code integer
message string
data object

fileUrl string

URL of the uploaded file. Pass this as the document URL in verification APIs.

Example (from schema)

{
  "code": 0,
  "message": "string",
  "data": {
    "fileUrl": "string"
  }
}

Success

Successful response

{
  "code": 0,
  "message": "Success",
  "data": {
    "fileUrl": "https://storage.googleapis.com/trential-images-dev/65940bdd9b271d7e123a90d2/bgv-twelfth/ff88720aefc6a461bbb60f9eee94d27afa4e4eac1c52a971481a41b5b06f7a66"
  }
}

Error

Error response

{
  "code": -1,
  "message": "Error message"
}

Loading...