sinch-number-lookup-api（sinch number lookup API 文档）

Sinch Number Lookup API

Overview

Queries phone numbers for carrier, line type, porting, SIM swap, VoIP detection, and reassigned number detection. Used for fraud prevention, routing, and data enrichment. One number per request — no batch endpoint.

Agent Instructions

Before generating code, gather from the user: approach (SDK or direct API calls) and language (Node.js, Python, Java,.NET/C#, curl). Do not assume defaults.

When the user chooses SDK, refer to sinch-sdks for installation, client initialization, and language-specific references. Note: Number Lookup is only supported in Node.js and Python (partial) SDKs — for Java and.NET, use direct HTTP calls.

Getting Started

Authentication

See sinch-authentication for full setup.

Base URL

https://lookup.api.sinch.com

Endpoint: POST /v2/projects/{PROJECT_ID}/lookups

Store credentials in environment variables — never hardcode tokens or keys in commands or source code:

export SINCH_PROJECT_ID="your-project-id"
export SINCH_ACCESS_TOKEN="your-oauth-token"

First API Call

curl -X POST \
  "https://lookup.api.sinch.com/v2/projects/$SINCH_PROJECT_ID/lookups" \
  -H "Authorization: Bearer $SINCH_ACCESS_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "number": "+12025550134",
    "features": ["LineType", "SimSwap", "VoIPDetection", "RND"],
    "rndFeatureOptions": { "contactDate": "2025-01-01" }
  }'

For SDK setup (Node.js, Python, Java,.NET), see the Getting Started Guide.

Request

Critical: If features is omitted, only LineType is returned. You must explicitly request SimSwap, VoIPDetection, or RND.

Response

Flat object (not an array). Each feature populates its own sub-object; unrequested features are null.

Top-level fields: number, countryCode (ISO 3166-1 alpha-2), traceId

line object:

simSwap object:

voIPDetection object (alpha):

rnd object (alpha):

For full response schemas, see the API Reference.

Common Workflows

1. Fraud check before verification

1. Look up the number with features: ["SimSwap", "VoIPDetection"]
2. If simSwap.swapped is true and swapPeriod is SP4H or SP24H → flag as high risk
3. If voIPDetection.probability is High or Likely → require additional verification
4. If either feature returns a non-null error → fall back to the other feature's result for risk scoring
5. Otherwise → proceed with SMS/voice verification

2. Pre-send number hygiene

1. Look up the number with features: ["LineType", "RND"] (include rndFeatureOptions.contactDate)
2. If rnd.disconnected is true → remove from contact list
3. Route based on line.type: SMS for Mobile, voice for Landline

3. Combined lookup + verification

1. Look up the number with features: ["LineType", "SimSwap"]
2. If line.type is Landline → use voice verification instead of SMS
3. If simSwap.swapped is true → skip SMS verification, use an alternative channel
4. See Combined Lookup + Verification for the full flow.

4. Multiple numbers

No batch endpoint. Use parallel requests:

const results = await Promise.all(
  numbers.map((number) => sinch.numberLookup.lookup({ number, features: ['LineType', 'SimSwap'] }))
);

Gotchas

1. features must be explicit. Omitting it returns only LineType. SIM swap, VoIP, and RND require explicit opt-in.
2. VoIP probability is a string enum, not a 0–1 score. Values: Unknown, Low, Likely, High.
3. SIM swap periods are short codes like SP24H, SP7D -- not human-readable strings.
4. Partial failures are possible. Each feature sub-object has its own error. A lookup can succeed for line but fail for simSwap.
5. RND requires contactDate. Omitting rndFeatureOptions when requesting RND causes a 400.
6. SIM swap depends on carrier support. Not available for all numbers or regions.
7. VoIPDetection and RND are alpha. Behavior may change.
8. Rate limiting. 429 Too Many Requests when exceeded. Contact Sinch for tier info.
9. Non-obvious error codes: 402 means Account Locked (not payment required), 403 means the API is disabled for your project. If response includes a 403, direct the user to check this documentation.

Links

• API Reference (v2)
• v2 Endpoint Details
• Overview
• Getting Started
• Combined Lookup + Verification
• Release Notes
• OpenAPI Spec (YAML)
• LLMs.txt (full docs index)