castomAPI
Odbierz klucz
POST /v1/verify/ssn bezpłatny Bez klucza Weryfikacja

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

POST

Żą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"
  }
}
Odpowiedź poniżej to makieta zbudowana ze schematu endpointu — żadne żądanie nie opuszcza tej strony. Zmień treść, naciśnij Wyślij, zobacz kształt odpowiedzi. Uruchom naprawdę w panelu →

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ść

PoleTypWymaganeOpis
ssnstringtakUS Social Security Number string (e.g., "000-00-0000" or "000000000")

Przykładowe żądanie

{
  "ssn": "078-05-1120"
}

Odpowiedź

PoleTypOpis
isValidboolean
ssnDetailsobject
  ↳ areaNumberstring
  ↳ groupNumberstring
  ↳ historicalStateOfOriginstring
  ↳ isPost2011Randomizedboolean
  ↳ maskedstring
  ↳ normalizedstring
  ↳ rawInputstring
  ↳ serialNumberstring
statusstring
tokensDeductedinteger
validationResultobject
  ↳ isAreaValidboolean
  ↳ isFormatValidboolean
  ↳ isGroupValidboolean
  ↳ isItinboolean
  ↳ isKnownTestNumberboolean
  ↳ isSerialValidboolean
  ↳ reasonstring

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.

400Treść albo parametr nie przeszły walidacji. Tablica details wskazuje pole.
401Brak klucza, klucz cofnięty albo zły nagłówek. Wyślij x-api-key.
402Portfel nie pokrywa tego wywołania. Doładuj albo poczekaj na miesięczny przydział.
404Zasób nie istnieje albo nie jest Twój. Obie sytuacje odpowiadają identycznie i nic nie kosztują.
429Przekroczony limit na minutę dla Twojego planu. Odczekaj i ponów.
5xxUsł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 klucza10
Free60
Pro300
Enterprise1200

Dokumentacja → Cennik

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