Result

Fetch the result of the FIR check for a specific transaction ID.

GET /v1/background-verification/fir-check/{transaction_id}

Retrieve FIR Check Result

cURL

curl --request GET \
  --url https://production.deepvue.tech/v1/background-verification/fir-check/{transaction_id} \
  --header 'Authorization: Bearer <token>' \
  --header 'x-api-key: <api-key>'

200

200 Success - Processing Complete

{
  "code": 200,
  "timestamp": 1767173662171,
  "transaction_id": "98c6e6e4f0ee4effb63e13ff67bea45a",
  "sub_code": "SUCCESS",
  "message": "Process complete.",
  "data": [
    {
      "fir_document_url": "https://production.deepvue.tech/v1/background-verification/fir-check/document?token=gAAAAABpgeDB7uRu-OJ0HJZxKgHi3IgCJ7g4Plb3jn-ZXYs39RXS3c9HDqkeEXGE-A_ZGUaFfVg7B7lZBWIYso_9bJFJTA7E2_Ba8F5zdZhNdvGSe2Q04NIsjt6gYNWEv99YPHpPusZb88Xf3Gd2QCg4Lf9022rSDMvklGPwd4OpQhPbb3sumvs=&exp=1772711361&sig=d0e795ce7e47d03e4274614ff65769a8d231c473029ccbf76d27092873ad086a",
      "fir_no": 159,
      "fir_year": "2019",
      "police_station": "SHILLEGAON",
      "state_name": "MAHARASHTRA",
      "name": "santosh sitaraam ahire",
      "name_match_type": "EXACT",
      "name_score": 100,
      "overall_match_type": "EXACT",
      "revised_case_category": "Criminal",
      "source": "fir"
    }
  ]
}

Authorizations

Authorization · string · header · required

ACCESS_TOKEN generated from the authorize endpoint. Should be included in the header as Bearer .

x-api-key · string · header · required

The CLIENT_SECRET provided to you. This header parameter is required for authentication purposes.

Path Parameters

transaction_id · string · required

Transaction ID received while creating the FIR check request

Query Parameters

name_match_type · string

Matching logic used for name comparison. Allowed values: EXACT_MATCH, EXACT_FUZZY, PARTIAL_EXACT, PARTIAL_FUZZY, NO_MATCH. Multiple values can be passed as a comma-separated string.

father_match_type · string

Matching logic used for father’s name comparison. Allowed values are the same as name_match_type. Multiple values can be passed as a comma-separated string.

type · string

Role of the individual in the FIR. Allowed values: RESPONDENT, PETITIONER. Multiple values can be passed as a comma-separated string.

case_category · string

Category of FIR. Allowed values: CIVIL, CRIMINAL. Multiple values can be passed as a comma-separated string.

case_status · string

Current status of FIR. Allowed values: PENDING, DISPOSED. Multiple values can be passed as a comma-separated string.

state_match · boolean

Whether FIR matching is done at the state level. Allowed values: true or false.

dist_match · boolean

Whether FIR matching is done at the district level. Allowed values: true or false.

jurisdiction_type · string

Jurisdiction coverage for FIR search. Allowed values: NEAREST_DISTRICTS, STATE, DISTRICT, PAN_INDIA. Multiple values can be passed as a comma-separated string.

algo_risk · string

Risk level assigned by the algorithm. Allowed values: VERY_HIGH_RISK, HIGH_RISK, MEDIUM_RISK, LOW_RISK, VERY_LOW_RISK. Multiple values can be passed as a comma-separated string.

Response

200

application/json

Successful Response

FIR Check Successful

In Progress

code · integer · default: 200

timestamp · integer

transaction_id · string

sub_code · string · default: SUCCESS

message · string · default: Process complete.

data · Data · object[]

Show child attributes