Weryfikuje strukturę numeru ubezpieczenia społecznego USA (SSN)
Weryfikuje strukturę numeru ubezpieczenia społecznego USA (SSN), sprawdza reguły zerowe, zakresy nieprawidłowych/nieprzypisanych kodów obszaru, identyfikację ITIN, znane numery testowe oraz stan pochodzenia sprzed 2011 roku
Żądanie
- x-api-key: <your-api-key>
- Content-Type: application/json
Odpowiedź
{
"isValid": true,
"ssnDetails": {
"areaNumber": "<area number>",
"groupNumber": "<group number>",
"historicalStateOfOrigin": "<historical state of origin>",
"isPost2011Randomized": true,
"masked": "<masked>",
"normalized": "PL61109010140000071219812874",
"rawInput": "PL61109010140000071219812874",
"serialNumber": "<serial number>"
},
"status": "success",
"tokensDeducted": 1,
"validationResult": {
"isAreaValid": true,
"isFormatValid": true,
"isGroupValid": true,
"isItin": true,
"isKnownTestNumber": true,
"isSerialValid": true,
"reason": "checksum ok"
}
}Co robi
Weryfikuje strukturę numeru ubezpieczenia społecznego USA (SSN), sprawdza reguły zerowe, zakresy nieprawidłowych/nieprzypisanych kodów obszaru, identyfikację ITIN, znane numery testowe oraz stan pochodzenia sprzed 2011 roku
Żądanie
Treść
| Pole | Typ | Wymagane | Opis |
|---|---|---|---|
ssn | string | tak | US Social Security Number string (e.g., "000-00-0000" or "000000000") |
Przykładowe żądanie
{
"ssn": "078-05-1120"
}Odpowiedź
| Pole | Typ | Opis |
|---|---|---|
isValid | boolean | |
ssnDetails | object | |
↳ areaNumber | string | |
↳ groupNumber | string | |
↳ historicalStateOfOrigin | string | |
↳ isPost2011Randomized | boolean | |
↳ masked | string | |
↳ normalized | string | |
↳ rawInput | string | |
↳ serialNumber | string | |
status | string | |
tokensDeducted | integer | |
validationResult | object | |
↳ isAreaValid | boolean | |
↳ isFormatValid | boolean | |
↳ isGroupValid | boolean | |
↳ isItin | boolean | |
↳ isKnownTestNumber | boolean | |
↳ isSerialValid | boolean | |
↳ reason | string |
Przykładowa odpowiedź
{
"isValid": true,
"ssnDetails": {
"areaNumber": "<area number>",
"groupNumber": "<group number>",
"historicalStateOfOrigin": "<historical state of origin>",
"isPost2011Randomized": true,
"masked": "<masked>",
"normalized": "PL61109010140000071219812874",
"rawInput": "PL61109010140000071219812874",
"serialNumber": "<serial number>"
},
"status": "success",
"tokensDeducted": 1,
"validationResult": {
"isAreaValid": true,
"isFormatValid": true,
"isGroupValid": true,
"isItin": true,
"isKnownTestNumber": true,
"isSerialValid": 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/ssn' \
-H 'x-api-key: <your-api-key>' \
-H 'Content-Type: application/json' \
-d '{"ssn": "078-05-1120"}'const res = await fetch('https://app.castomapi.com/v1/verify/ssn', {
method: 'POST',
headers: { 'x-api-key': '<your-api-key>', 'Content-Type': 'application/json' },
body: JSON.stringify({"ssn": "078-05-1120"})
});
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/ssn', {
method: 'POST',
headers: { 'x-api-key': '<your-api-key>', 'Content-Type': 'application/json' },
body: JSON.stringify({"ssn": "078-05-1120"})
});
const data = await res.json();
console.log(data);import requests
res = requests.post(
'https://app.castomapi.com/v1/verify/ssn',
headers={'x-api-key': '<your-api-key>'},
json={"ssn": "078-05-1120"},
timeout=30,
)
print(res.json())<?php
$ch = curl_init('https://app.castomapi.com/v1/verify/ssn');
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(['ssn' => '078-05-1120']),
]);
$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 Weryfikuje strukturę numeru ubezpieczenia społecznego USA (SSN)?
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