Parsowanie ciągów MRZ (Machine Readable Zone) zgodnych z ICAO Doc 9303…
Parsowanie ciągów MRZ (Machine Readable Zone) zgodnych z ICAO Doc 9303 z paszportów, wiz i dowodów osobistych. Waliduje cyfry kontrolne Modulo 10, daty urodzenia, daty ważności oraz nadrzędne sumy kontrolne kompozytowe
Żądanie
- x-api-key: <your-api-key>
- Content-Type: application/json
Odpowiedź
{
"isValid": true,
"parsedDetails": {
"birthDate": "2026-09-08",
"documentFormat": "json",
"documentNumber": "<document number>",
"documentType": "standard",
"expirationDate": "2026-09-08",
"givenNames": "<given names>",
"issuingCountry": "PL",
"nationality": "<nationality>",
"personalNumber": "<personal number>",
"sex": "<sex>",
"surname": "<surname>"
},
"status": "success",
"tokensDeducted": 2,
"validationResult": {
"isDobValid": true,
"isDocNumberValid": true,
"isExpiryValid": true,
"isMasterValid": true,
"isPersonalNumberValid": true,
"reason": "checksum ok"
}
}Co robi
Parsowanie ciągów MRZ (Machine Readable Zone) zgodnych z ICAO Doc 9303 z paszportów, wiz i dowodów osobistych. Waliduje cyfry kontrolne Modulo 10, daty urodzenia, daty ważności oraz nadrzędne sumy kontrolne kompozytowe
Żądanie
Treść
| Pole | Typ | Wymagane | Opis |
|---|---|---|---|
mrz | array<string> | tak | Array of MRZ lines (e.g. 2 lines for TD3/Passport, 3 lines for TD1/ID Card) |
Przykładowe żądanie
{
"mrz": [
"<mrz>"
]
}Odpowiedź
| Pole | Typ | Opis |
|---|---|---|
isValid | boolean | |
parsedDetails | object | |
↳ birthDate | string | |
↳ documentFormat | string | |
↳ documentNumber | string | |
↳ documentType | string | |
↳ expirationDate | string | |
↳ givenNames | string | |
↳ issuingCountry | string | |
↳ nationality | string | |
↳ personalNumber | string | |
↳ sex | string | |
↳ surname | string | |
status | string | |
tokensDeducted | integer | |
validationResult | object | |
↳ isDobValid | boolean | |
↳ isDocNumberValid | boolean | |
↳ isExpiryValid | boolean | |
↳ isMasterValid | boolean | |
↳ isPersonalNumberValid | boolean | |
↳ reason | string |
Przykładowa odpowiedź
{
"isValid": true,
"parsedDetails": {
"birthDate": "2026-09-08",
"documentFormat": "json",
"documentNumber": "<document number>",
"documentType": "standard",
"expirationDate": "2026-09-08",
"givenNames": "<given names>",
"issuingCountry": "PL",
"nationality": "<nationality>",
"personalNumber": "<personal number>",
"sex": "<sex>",
"surname": "<surname>"
},
"status": "success",
"tokensDeducted": 2,
"validationResult": {
"isDobValid": true,
"isDocNumberValid": true,
"isExpiryValid": true,
"isMasterValid": true,
"isPersonalNumberValid": true,
"reason": "checksum ok"
}
}Błędy
Każdy błąd ma tę samą kopertę: status HTTP, kod maszynowy i jedno zdanie.
400 | Treść albo parametr nie przeszły walidacji. Tablica details wskazuje pole. |
401 | Brak klucza, klucz cofnięty albo zły nagłówek. Wyślij x-api-key. |
402 | Portfel nie pokrywa tego wywołania. Doładuj albo poczekaj na miesięczny przydział. |
404 | Zasób nie istnieje albo nie jest Twój. Obie sytuacje odpowiadają identycznie i nic nie kosztują. |
429 | Przekroczony limit na minutę dla Twojego planu. Odczekaj i ponów. |
5xx | Usługa nadrzędna odmówiła albo przekroczyła czas. Wywołanie nie jest rozliczane. |
Kod
curl -X POST 'https://app.castomapi.com/v1/verify/mrz' \
-H 'x-api-key: <your-api-key>' \
-H 'Content-Type: application/json' \
-d '{"mrz": ["<mrz>"]}'const res = await fetch('https://app.castomapi.com/v1/verify/mrz', {
method: 'POST',
headers: { 'x-api-key': '<your-api-key>', 'Content-Type': 'application/json' },
body: JSON.stringify({"mrz": ["<mrz>"]})
});
const data = await res.json();
console.log(data);import { request } from 'node:https';
// Node 18+ has fetch built in
const res = await fetch('https://app.castomapi.com/v1/verify/mrz', {
method: 'POST',
headers: { 'x-api-key': '<your-api-key>', 'Content-Type': 'application/json' },
body: JSON.stringify({"mrz": ["<mrz>"]})
});
const data = await res.json();
console.log(data);import requests
res = requests.post(
'https://app.castomapi.com/v1/verify/mrz',
headers={'x-api-key': '<your-api-key>'},
json={"mrz": ["<mrz>"]},
timeout=30,
)
print(res.json())<?php
$ch = curl_init('https://app.castomapi.com/v1/verify/mrz');
curl_setopt_array($ch, [
CURLOPT_CUSTOMREQUEST => 'POST',
CURLOPT_RETURNTRANSFER => true,
CURLOPT_HTTPHEADER => ['x-api-key: <your-api-key>', 'Content-Type: application/json'],
CURLOPT_POSTFIELDS => json_encode(['mrz' => ['<mrz>']]),
]);
$data = json_decode(curl_exec($ch), true);
print_r($data);Koszt i limity
Ta operacja nie wymaga klucza API i nic nie kosztuje: wywołana bez klucza odpowiada 200 i pobiera zero tokenów, do 10 żądań na minutę z jednego adresu IP.
Limity żądań na minutę
| Bez klucza | 10 |
| Free | 60 |
| Pro | 300 |
| Enterprise | 1200 |
Pytania
Ile kosztuje Parsowanie ciągów MRZ (Machine Readable Zone) zgodnych z ICAO Doc 9303…?
Ta operacja nie wymaga klucza API i nic nie kosztuje: wywołana bez klucza odpowiada 200 i pobiera zero tokenów, do 10 żądań na minutę z jednego adresu IP.
Jak się uwierzytelnić?
Wyślij klucz w nagłówku x-api-key. Jeden klucz obejmuje każdy rozliczany endpoint; niczego nie trzeba włączać osobno.
Czy mogę wysłać nagłówek Authorization: Bearer zamiast klucza?
Nie dla rozliczanego endpointu — te przyjmują wyłącznie nagłówek x-api-key. Tokeny Bearer należą do strony konta: panel i API konta przyjmują sesję JWT, a castomapi-auth wydaje je standardowym uzgodnieniem OAuth2, z grantami authorization code, client credentials i refresh. Opisuje to strona usługi auth.
Jakie są limity?
10 żądań na minutę z jednego IP zupełnie bez klucza, 60 na minutę w planie Free, 300 w Pro, 1200 w Enterprise. Powyżej poziomu bez klucza limit jest na konto, łącznie dla wszystkich endpointów.
OpenAPI: https://app.castomapi.com/docs/json