FIR CheckResult

Retrieve FIR Check Result

Retrieve the result of an asynchronous FIR check.

curl -X GET "https://production.deepvue.tech/v1/background-verification/fir-check/example_string?name_match_type=EXACT_MATCH,EXACT_FUZZY&father_match_type=example_string&type=example_string&case_category=example_string&case_status=example_string&state_match=true&dist_match=true&jurisdiction_type=example_string&algo_risk=example_string" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer YOUR_API_TOKEN (JWT)" \
  -H "x-api-key: YOUR_API_KEY"
{
  "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"
    }
  ]
}
GET
/v1/background-verification/fir-check/{transaction_id}
GET
Bearer Token (JWT)
Bearer Tokenstring
Required

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

ACCESS_TOKEN generated from the authorize endpoint. Should be included in the header as Bearer .
API Key (header: x-api-key)
x-api-keystring
Required

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

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

Transaction ID received while creating the FIR check request

query
name_match_typestring

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.

query
father_match_typestring

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.

query
typestring

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

query
case_categorystring

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

query
case_statusstring

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

query
state_matchboolean

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

query
dist_matchboolean

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

query
jurisdiction_typestring

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

query
algo_riskstring

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.

Request Preview
Response

Response will appear here after sending the request

Authentication

header
Authorizationstring
Required

Bearer token (JWT). ACCESS_TOKEN generated from the authorize endpoint. Should be included in the header as Bearer .

header
x-api-keystring
Required

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

Path Parameters

transaction_idstring
Required

Transaction ID received while creating the FIR check request

Query Parameters

name_match_typestring

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_typestring

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.

typestring

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

case_categorystring

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

case_statusstring

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

state_matchboolean

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

dist_matchboolean

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

jurisdiction_typestring

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

algo_riskstring

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.

Responses

codeinteger
timestampinteger
transaction_idstring
sub_codestring
messagestring
dataarray

Overview

This API retrieves the results of an FIR (First Information Report) background verification check for a transaction ID that was previously initiated.

Successful responses include detailed FIR information such as the FIR number, year, associated police station, state, individual's name with matching scores, case category, and a URL to the FIR document.

Filtering capabilities

You can filter results using the following criteria:

  • Name matching logic -- exact, fuzzy, or partial matches
  • Party role -- respondent or petitioner
  • Case category -- civil or criminal
  • Case status -- pending or disposed
  • Geographic jurisdiction -- state, district, or pan-India coverage
  • Risk assessment levels

The response indicates whether processing has completed or remains in progress. If processing is still underway, you can poll the endpoint again later.