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

Weryfikuj strukturę Canadian Social Insurance Number (SIN)

Weryfikuj strukturę Canadian Social Insurance Number (SIN), sumę kontrolną Modulo 10 Luhna, przydział do regionalnego biura ESDC, status tymczasowego rezydenta (zaczyna się od 9) i znane numery testowe

POST

Żądanie

  • x-api-key: <your-api-key>
  • Content-Type: application/json

Odpowiedź

{
  "isValid": true,
  "sinDetails": {
    "firstDigit": "<first digit>",
    "formattedPrint": "PL61 1090 1014 0000 0712 1981 2874",
    "masked": "<masked>",
    "normalized": "PL61109010140000071219812874",
    "provinces": [
      "<province>"
    ],
    "rawInput": "PL61109010140000071219812874",
    "regionName": "Ada Lovelace"
  },
  "status": "success",
  "tokensDeducted": 1,
  "validationResult": {
    "isFirstDigitValid": true,
    "isFormatValid": true,
    "isKnownTestNumber": true,
    "isLuhnValid": true,
    "isTemporaryResident": 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

Weryfikuj strukturę Canadian Social Insurance Number (SIN), sumę kontrolną Modulo 10 Luhna, przydział do regionalnego biura ESDC, status tymczasowego rezydenta (zaczyna się od 9) i znane numery testowe

Żądanie

Treść

PoleTypWymaganeOpis
sinstringtakCanadian Social Insurance Number string (e.g. "000 000 000", "000-000-000", or "000000000")

Przykładowe żądanie

{
  "sin": "046 454 286"
}

Odpowiedź

PoleTypOpis
isValidboolean
sinDetailsobject
  ↳ firstDigitstring
  ↳ formattedPrintstring
  ↳ maskedstring
  ↳ normalizedstring
  ↳ provincesarray<string>
  ↳ rawInputstring
  ↳ regionNamestring
statusstring
tokensDeductedinteger
validationResultobject
  ↳ isFirstDigitValidboolean
  ↳ isFormatValidboolean
  ↳ isKnownTestNumberboolean
  ↳ isLuhnValidboolean
  ↳ isTemporaryResidentboolean
  ↳ reasonstring

Przykładowa odpowiedź

{
  "isValid": true,
  "sinDetails": {
    "firstDigit": "<first digit>",
    "formattedPrint": "PL61 1090 1014 0000 0712 1981 2874",
    "masked": "<masked>",
    "normalized": "PL61109010140000071219812874",
    "provinces": [
      "<province>"
    ],
    "rawInput": "PL61109010140000071219812874",
    "regionName": "Ada Lovelace"
  },
  "status": "success",
  "tokensDeducted": 1,
  "validationResult": {
    "isFirstDigitValid": true,
    "isFormatValid": true,
    "isKnownTestNumber": true,
    "isLuhnValid": true,
    "isTemporaryResident": 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/sin' \
  -H 'x-api-key: <your-api-key>' \
  -H 'Content-Type: application/json' \
  -d '{"sin": "046 454 286"}'
const res = await fetch('https://app.castomapi.com/v1/verify/sin', {
  method: 'POST',
  headers: { 'x-api-key': '<your-api-key>', 'Content-Type': 'application/json' },
  body: JSON.stringify({"sin": "046 454 286"})
});
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/sin', {
  method: 'POST',
  headers: { 'x-api-key': '<your-api-key>', 'Content-Type': 'application/json' },
  body: JSON.stringify({"sin": "046 454 286"})
});
const data = await res.json();
console.log(data);
import requests

res = requests.post(
    'https://app.castomapi.com/v1/verify/sin',
    headers={'x-api-key': '<your-api-key>'},
    json={"sin": "046 454 286"},
    timeout=30,
)
print(res.json())
<?php
$ch = curl_init('https://app.castomapi.com/v1/verify/sin');
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(['sin' => '046 454 286']),
]);
$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 Weryfikuj strukturę Canadian Social Insurance Number (SIN)?

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