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"
import requests
import json
url = "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"
headers = {
"Content-Type": "application/json",
"Authorization": "Bearer YOUR_API_TOKEN (JWT)",
"x-api-key": "YOUR_API_KEY"
}
response = requests.get(url, headers=headers)
print(response.json())
const response = await fetch("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", {
method: "GET",
headers: {
"Content-Type": "application/json",
"Authorization": "Bearer YOUR_API_TOKEN (JWT)",
"x-api-key": "YOUR_API_KEY"
}
});
const data = await response.json();
console.log(data);
package main
import (
"fmt"
"net/http"
)
func main() {
req, err := http.NewRequest("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", nil)
if err != nil {
panic(err)
}
req.Header.Set("Content-Type", "application/json")
req.Header.Set("Authorization", "Bearer YOUR_API_TOKEN (JWT)")
req.Header.Set("x-api-key", "YOUR_API_KEY")
client := &http.Client{}
resp, err := client.Do(req)
if err != nil {
panic(err)
}
defer resp.Body.Close()
fmt.Println("Response Status:", resp.Status)
}
require 'net/http'
require 'json'
uri = URI('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')
http = Net::HTTP.new(uri.host, uri.port)
http.use_ssl = true
request = Net::HTTP::Get.new(uri)
request['Content-Type'] = 'application/json'
request['Authorization'] = 'Bearer YOUR_API_TOKEN (JWT)'
request['x-api-key'] = 'YOUR_API_KEY'
response = http.request(request)
puts response.body
{
"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"
}
]
}
{
"code": 200,
"timestamp": 1767173627936,
"transaction_id": "b10ead4473ff4283ac9ea40464fbb6c0",
"sub_code": "IN_PROGRESS",
"message": "Request processing is in progress."
}
{
"detail": "Inactive client_id"
}
{
"detail": "Not authenticated"
}
{
"detail": "Not a valid token"
}
{
"code": 422,
"timestamp": 1767177410430,
"transaction_id": "0acca1189f4e4a729d2edf8077e529e2",
"sub_code": "INVALID_REQUEST_ID",
"message": "Invalid Request ID"
}
{
"detail": "Internal Server Error"
}
/v1/background-verification/fir-check/{transaction_id}ACCESS_TOKEN generated from the authorize endpoint. Should be included in the header as Bearer .
The CLIENT_SECRET provided to you. This header parameter is required for authentication purposes.
Transaction ID received while creating the FIR check request
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.
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.
Role of the individual in the FIR. Allowed values: RESPONDENT, PETITIONER. Multiple values can be passed as a comma-separated string.
Category of FIR. Allowed values: CIVIL, CRIMINAL. Multiple values can be passed as a comma-separated string.
Current status of FIR. Allowed values: PENDING, DISPOSED. Multiple values can be passed as a comma-separated string.
Whether FIR matching is done at the state level. Allowed values: true or false.
Whether FIR matching is done at the district level. Allowed values: true or false.
Jurisdiction coverage for FIR search. Allowed values: NEAREST_DISTRICTS, STATE, DISTRICT, PAN_INDIA. Multiple values can be passed as a comma-separated 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.
Request Preview
Response
Response will appear here after sending the request
Authentication
Bearer token (JWT). ACCESS_TOKEN generated from the authorize endpoint. Should be included in the header as Bearer .
API Key for authentication. The CLIENT_SECRET provided to you. This header parameter is required for authentication purposes.
Path Parameters
Transaction ID received while creating the FIR check request
Query Parameters
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.
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.
Role of the individual in the FIR. Allowed values: RESPONDENT, PETITIONER. Multiple values can be passed as a comma-separated string.
Category of FIR. Allowed values: CIVIL, CRIMINAL. Multiple values can be passed as a comma-separated string.
Current status of FIR. Allowed values: PENDING, DISPOSED. Multiple values can be passed as a comma-separated string.
Whether FIR matching is done at the state level. Allowed values: true or false.
Whether FIR matching is done at the district level. Allowed values: true or false.
Jurisdiction coverage for FIR search. Allowed values: NEAREST_DISTRICTS, STATE, DISTRICT, PAN_INDIA. Multiple values can be passed as a comma-separated 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.
Responses
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.
Last updated 4 weeks ago
Built with Documentation.AI