---
title: "Number Verification API"
url: "https://developer.pxg.konera.com/apis/number-verification-v1/versions/1554527f-4237-4b00-a8d4-a6b8d30bda00"
---

# Number Verification API

OpenAPI specification document.

```json
{"openapi":"3.0.3","info":{"title":"Number Verification API","description":"CAMARA Number Verification API. Confirms whether the phone number provided by the service provider matches the phone number of the device/SIM on the mobile network.","version":"1.0.0"},"servers":[{"url":"https://api.pxg.konera.com/camara","description":"Production CAMARA API Gateway"}],"tags":[{"name":"Number Verification V1","description":"Phone number ownership verification APIs (v1)"}],"security":[{"OAuth2ClientCredentials":["number-verification.read"]}],"paths":{"/api/auth/v1/authorize":{"get":{"tags":["Number Verification V1"],"summary":"authorize (Authorization Code)","operationId":"auth-v1_authorize","description":"OAuth 2.0 / OpenID Connect authorization endpoint for Number Verification v1. Returns **302 Found** redirecting the user-agent to the Operator Authorization Server.","security":[],"parameters":[{"name":"response_type","in":"query","required":true,"schema":{"type":"string","example":"code"}},{"name":"scope","in":"query","required":true,"schema":{"type":"string","example":"openid dpv:FraudPreventionAndDetection number-verification:verify offline_access"}},{"name":"client_id","in":"query","required":true,"schema":{"type":"string"}},{"name":"login_hint","in":"query","required":false,"schema":{"type":"string","description":"Login hint, e.g., tel:+34666666666 (URL-encoded when used)."}},{"name":"state","in":"query","required":false,"schema":{"type":"string"}},{"name":"redirect_uri","in":"query","required":true,"schema":{"type":"string","format":"uri"}},{"name":"prompt","in":"query","required":false,"schema":{"type":"string","example":"none"}},{"name":"konera_context","in":"query","required":false,"schema":{"type":"string","description":"Optional Konera context, typically containing ipv4/ipv6 hints (URL-encoded), e.g. ipv4:142.115.147.143,ipv6:2001:4860:7:f04::fe"}}],"responses":{"302":{"description":"Redirect to Operator Authorization Server.","headers":{"Location":{"description":"Operator authorization URL.","schema":{"type":"string","format":"uri"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"429":{"$ref":"#/components/responses/TooManyRequests"},"500":{"$ref":"#/components/responses/InternalServerError"},"503":{"$ref":"#/components/responses/ServiceUnavailable"}}}},"/api/auth/v1/token":{"post":{"tags":["Number Verification V1"],"summary":"token (Authorization Code Exchange)","operationId":"auth-v1_token","description":"OAuth 2.0 token endpoint to exchange authorization code for access token (CAMARA style).","security":[],"requestBody":{"required":true,"content":{"application/x-www-form-urlencoded":{"schema":{"$ref":"#/components/schemas/TokenRequest"}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TokenResponse"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"429":{"$ref":"#/components/responses/TooManyRequests"},"500":{"$ref":"#/components/responses/InternalServerError"},"503":{"$ref":"#/components/responses/ServiceUnavailable"}}}},"/api/number-verification/v1/verify":{"post":{"tags":["Number Verification V1"],"summary":"phoneNumberVerifyV1","operationId":"number-verification-v1_verify","description":"Verifies whether the phone number provided matches the number currently allocated to the SIM in the end user's device. Returns a boolean result in `devicePhoneNumberVerified`.","parameters":[{"$ref":"#/components/parameters/XCorrelator"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PhoneNumberVerifyRequest"}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NumberVerificationResult"},"examples":{"verified":{"value":{"devicePhoneNumberVerified":true}}}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"409":{"$ref":"#/components/responses/Conflict"},"422":{"$ref":"#/components/responses/UnprocessableEntity"},"429":{"$ref":"#/components/responses/TooManyRequests"},"500":{"$ref":"#/components/responses/InternalServerError"},"503":{"$ref":"#/components/responses/ServiceUnavailable"}}}}},"components":{"parameters":{"XCorrelator":{"name":"x-correlation-id","in":"header","required":false,"description":"Correlation ID for request tracing","schema":{"type":"string","example":"b4333c46-49c0-4f62-80d7-f0ef930f1c46"}}},"responses":{"BadRequest":{"description":"Bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"Unauthorized":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"Forbidden":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"NotFound":{"description":"Not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"Conflict":{"description":"Conflict","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"UnprocessableEntity":{"description":"Unprocessable entity","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"TooManyRequests":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"InternalServerError":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"ServiceUnavailable":{"description":"Service unavailable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"securitySchemes":{"OAuth2ClientCredentials":{"type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://auth.konera.com/oauth2/token","scopes":{"number-verification.read":"Verify device phone number match"}}}}},"schemas":{"PhoneNumberVerifyRequest":{"type":"object","required":["phoneNumber"],"properties":{"phoneNumber":{"type":"string","description":"MSISDN in E.164 format entered by the end user","example":"+919036499174"}}},"NumberVerificationResult":{"type":"object","required":["devicePhoneNumberVerified"],"properties":{"devicePhoneNumberVerified":{"type":"boolean","description":"Indicates whether the provided MSISDN matches the phone number of the device/SIM on the network","example":true},"assessedAt":{"type":"string","format":"date-time","nullable":true,"description":"Timestamp when verification was performed"}}},"TokenRequest":{"type":"object","required":["grant_type","code","redirect_uri","client_id","client_secret"],"properties":{"grant_type":{"type":"string","enum":["authorization_code"],"example":"authorization_code"},"code":{"type":"string","description":"Authorization code received from authorize endpoint"},"redirect_uri":{"type":"string","format":"uri","description":"Must match the redirect URI used in the authorize request"},"client_id":{"type":"string","description":"Client identifier"},"client_secret":{"type":"string","description":"Client secret"}}},"TokenResponse":{"type":"object","required":["access_token","token_type","expires_in","scope"],"properties":{"access_token":{"type":"string","description":"Access token for API calls"},"token_type":{"type":"string","enum":["Bearer"],"example":"Bearer"},"expires_in":{"type":"integer","description":"Token expiration time in seconds","example":3600},"scope":{"type":"string","description":"Granted scopes","example":"openid number-verification:verify"},"refresh_token":{"type":"string","description":"Refresh token if offline_access was requested"},"id_token":{"type":"string","description":"OpenID Connect ID token if openid scope was requested"}}},"Error":{"type":"object","required":["status","code","message"],"properties":{"status":{"type":"integer","example":400},"code":{"type":"string","example":"INVALID_ARGUMENT"},"message":{"type":"string","example":"Invalid request"}}},"RedirectResponse":{"type":"object","description":"Redirect response model","properties":{}}}}}
```