> ## Documentation Index
> Fetch the complete documentation index at: https://venator-06aff335.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.
# Document OCR
Extract structured data from identity documents by submitting front and back images in base64 format. The service performs Optical Character Recognition (OCR) and returns parsed fields such as name, document number, and date of birth.
POST
/api/gw/services/document\_ocr
***
### Authorizations
***
### Body
Base64 encoded front image of the document.
Base64 encoded back image of the document (if applicable).
Type of document (e.g., passport, id\_card, driver\_license).
Issuing country of the document (ISO3 format recommended).
***
### Response
Indicates whether the request was processed successfully.
Unique identifier for the API request.
Identifier used for tracing the request across systems.
Contains extracted document details.
Detected document type (e.g., PASSPORT).
Country that issued the document (ISO code).
Extracted document number.
Extracted first name.
Extracted last name.
Extracted date of birth (YYYY-MM-DD).
Extracted gender (e.g., M/F).
Extracted nationality (ISO code).
Document issue date (YYYY-MM-DD).
Document expiry date (YYYY-MM-DD).
Indicates whether the document is expired.
Machine-readable zone line 1.
Machine-readable zone line 2.
Machine-readable zone line 3 (if available).
Confidence score for extracted data (0 to 1).
Extracted face image in base64 format (data URL).
Contains error details if the request fails; otherwise null.
Time taken to process the request in milliseconds.
Timestamp when the request was processed (ISO 8601 format).
Error message returned when OCR processing fails.
***
```bash Curl theme={null}
curl -X POST "https://dev-idf-gw.cognetlabs.org/api/gw/services/document_ocr" \
-H "Content-Type: application/json" \
-d '{
"frontImageBase64": "",
"backImageBase64": "",
"documentType": "passport",
"documentCountry": "GBR"
}'
```
```python Python theme={null}
import requests
url = "https://dev-idf-gw.cognetlabs.org/api/gw/services/document_ocr"
payload = {
"frontImageBase64": "",
"backImageBase64": "",
"documentType": "passport",
"documentCountry": "GBR"
}
res = requests.post(url, json=payload)
print(res.json())
```
```javascript JavaScript theme={null}
fetch("https://dev-idf-gw.cognetlabs.org/api/gw/services/document_ocr", {
method: "POST",
headers: {
"Content-Type": "application/json"
},
body: JSON.stringify({
frontImageBase64: "",
backImageBase64: "",
documentType: "passport",
documentCountry: "GBR"
})
})
.then(res => res.json())
.then(console.log);
```
```php PHP theme={null}
"",
"backImageBase64" => "",
"documentType" => "passport",
"documentCountry" => "GBR"
];
$ch = curl_init($url);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_POSTFIELDS, json_encode($data));
curl_setopt($ch, CURLOPT_HTTPHEADER, ['Content-Type: application/json']);
$response = curl_exec($ch);
curl_close($ch);
echo $response;
?>
```
```go Go theme={null}
package main
import (
"bytes"
"net/http"
)
func main() {
json := []byte(`{
"frontImageBase64":"",
"backImageBase64":"",
"documentType":"passport",
"documentCountry":"GBR"
}`)
http.Post(
"https://dev-idf-gw.cognetlabs.org/api/gw/services/document_ocr",
"application/json",
bytes.NewBuffer(json),
)
}
```
```java Java theme={null}
import okhttp3.*;
public class Main {
public static void main(String[] args) throws Exception {
OkHttpClient client = new OkHttpClient();
String json = "{\"frontImageBase64\":\"\", \"backImageBase64\":\"\", \"documentType\":\"passport\", \"documentCountry\":\"GBR\" }";
RequestBody body = RequestBody.create(json, MediaType.parse("application/json"));
Request request = new Request.Builder()
.url("https://dev-idf-gw.cognetlabs.org/api/gw/services/document_ocr")
.post(body)
.build();
Response response = client.newCall(request).execute();
System.out.println(response.body().string());
}
}
```
```ruby Ruby theme={null}
require 'net/http'
require 'uri'
require 'json'
uri = URI("https://dev-idf-gw.cognetlabs.org/api/gw/services/document_ocr")
payload = {
frontImageBase64: "",
backImageBase64: "",
documentType: "passport",
documentCountry: "GBR"
}
http = Net::HTTP.new(uri.host, uri.port)
request = Net::HTTP::Post.new(uri, {'Content-Type': 'application/json'})
request.body = payload.to_json
response = http.request(request)
puts response.body
```
```json 200 theme={null}
{
"success":true,
"requestId":"da0a115e519e",
"correlationId":"58664e8f17d1452ea3b171e7a90e09bf",
"data":{
"documentType":"PASSPORT",
"issuingCountry":"GBR",
"documentNumber":"123456789",
"firstName":"John",
"lastName":"Doe",
"dateOfBirth":"1992-05-11",
"gender":"M",
"nationality":"GBR",
"issueDate":"2018-01-01",
"expiryDate":"2028-01-01",
"isExpired":false,
"mrzLine1":"P