IDCanopy Developers
Umbrella API

Phone

Phone status, ID, risk score, verification and full intelligence

What it returns

Five related operations against a phone number: line status, phone ID lookup, a risk score for a given account lifecycle event, an OTP-based verification pair, and a full-intelligence bundle.

Request

POST /phone-service/phoneStatus, { "phoneNumber": "+..." } (E.164).

POST /phone-service/phoneid, phoneNumber required; optional accountLifecycleEvent (create, sign-in, transact, update, delete), externalId, originatingIp, addons, consent.

POST /phone-service/phoneRiskScore, phoneNumber and accountLifecycleEvent required; optional externalId, originatingIp, deviceId, accountId, emailAddress.

POST /phone-service/fullPhoneIntelligence, { "phoneNumber": "+..." }.

POST /phone-service/verification, method required (sms or email); phoneNumber required if method is sms, email required if method is email; optional securityFactor (custom 3–10 digit OTP), externalId, messageTemplate, voiceLang.

PATCH /phone-service/verification/{referenceId}, { "securityFactor": "..." }, the OTP the end user provided.

Response

phoneStatus returns referenceId, status.code/description, phoneType, blocklisting - all camelCase. phoneid, phoneRiskScore, fullPhoneIntelligence, verification and the verification-match call return status (boolean, whether the API call itself succeeded) and a data object whose inner shape carries the actual result.

Decision

The caller decides from status.code/phoneType for line status, and from the enrichment fields inside data for risk and verification calls.

Test cases

Pending.

Reference

Umbrella API reference.

On this page