Identity Management

GET /phone/{phone}/status

Requires authentication with server access token.

Get verification and availability status for a phone number. Note that the phone number should be base64 encoded, following standard +46736151515.

See also

Help us improve

Did you spot an error? Or maybe you just have a suggestion for how we can improve? Leave us a comment.

Request

GET /api/2/phone/{phone}/status

phone

required path parameter

The phone number to query status for.

Example request

cURL
curl https://login.schibsted.com/api/2/phone/KzQ2NzAxMTExMTEx/status -G \
   -d "oauth_token=[access token]"
Java
SpidOAuthToken token = spidClient.getServerToken();
String responseJSON = spidClient.
    GET(token, "/phone/KzQ2NzAxMTExMTEx/status").
    getResponseBody();

This example is an excerpt, see a full example

PHP
<?php
$client->auth();
echo var_dump($client->api("/phone/KzQ2NzAxMTExMTEx/status"));

This example is an excerpt, see a full example

Clojure
(ns example
  (:require [spid-client-clojure.core :as spid]))

(let [client (spid/create-client "[client-id]" "[secret]")
      token (spid/create-server-token client)]
  (spid/GET client token "/phone/KzQ2NzAxMTExMTEx/status"))

Response

This endpoint supports the JSON and JSON-P response formats.

Success: 200 OK

Returns a status description.

Phone Status

exists

boolean

If true, this phone number exists in some form in SPiD

available

boolean

If true, this phone number address may be used to register a new account

verified

boolean

If true, the owner has verified this phone number in SPiD.

The check mark indicates that the field always contains a valid non-empty value.

Failure cases

Some HTTP response codes are used for multiple error situations. There is no consistent way to tell these apart, but the error object will contain a textual explanation of the reason for the error. For explanation on OAuth related failures and errors see OAuth authentication failures.

  • 400 Bad Request Missing parameter phone
  • 400 Bad Request Phone parameter did not properly base64 decode into a valid phone number
  • 401 Unauthorized You don't have administration rights for this client.
  • 401 Unauthorized Your client doesn't have administration rights for this client.
  • 403 Forbidden Client is not authorized to access this API endpoint. Contact SPiD to request access.
  • 403 Forbidden Requesting IP is not whitelisted
  • 403 Forbidden Access token rejected
  • 404 Not Found Unknown client ID
  • 404 Not Found Client ID mismatch. The client making the request is no the owner of this resource, and does not have administrative privileges for it.
  • 420 Request Ratelimit exceeded

Sample response

JSON
{
  "exists": false,
  "available": true,
  "verified": false
}
JSON-P
callback({
  "exists": false,
  "available": true,
  "verified": false
});

Comments/feedback

Do you have questions, or just want to contribute some newly gained insight? Want to share an example? Please leave a comment. SPiD reads and responds to every question. Additionally, your experience can help others using SPiD, and it can help us continuously improve our documentation.