Skip to main content
Versionv1
API docs by Redocly

Mobile Identity API (1.0.0)

Download OpenAPI specification:Download

Mobile Identity API

Identity Match

Request an Identity Match check

Identity Match

Match the provided person details to the given phone number

Authorizations:
JWT
Request Body schema: application/json
required
phoneNumber
required
string

The phone number to match the person to. Must be in E.164 format.

serviceType
required
string (IdentityMatchType)
Enum: "match" "score"

Type of Identity Match response to be retrieved.

firstName
string or null <= 255 characters

The first name of the person to match to

lastName
string or null <= 255 characters

The last name of the person to match to

address
string or null <= 255 characters

House number, first line of the address of the person to match to

address2
string or null <= 255 characters

Optional additional address line

address3
string or null <= 255 characters

Optional additional address line

postalCode
string or null <= 255 characters

Postal code of the address of the person to match to

dateOfBirth
string or null <date>

The date of birth of the person to match to. In 'YYYY-MM-DD' format.

Responses

Request samples

Content type
application/json
{
  • "phoneNumber": "+31612345678",
  • "serviceType": "match",
  • "firstName": "John",
  • "lastName": "Doe",
  • "address": "Konijnenberg 24",
  • "address2": "string",
  • "address3": "string",
  • "postalCode": "4825 BD",
  • "dateOfBirth": "1965-03-10"
}

Response samples

Content type
application/json
Example
{
  • "state": "success",
  • "firstNameMatch": true,
  • "lastNameMatch": true,
  • "nameMatch": true,
  • "addressMatch": true,
  • "postalCodeMatch": true,
  • "dateOfBirthMatch": true
}

SIM Swap

Request a SIM Swap check

SIM swap

Request the date time of the last SIM swap of the provided phone number

Authorizations:
JWT
Request Body schema: application/json
required
phoneNumber
required
string

The phone number to match the person to. Must be in E.164 format.

serviceType
required
string (SimSwapType)
Enum: "timestamp" "24h"

Type of SIM Swap response to be retrieved.

Responses

Request samples

Content type
application/json
{
  • "phoneNumber": "+31612345678",
  • "serviceType": "timestamp"
}

Response samples

Content type
application/json
Example
{
  • "state": "success",
  • "timestamp": "2026-01-01T00:00:00Z"
}

Number Verify

Verify a phone number

Request number verify

Verify if a provided phone number is valid and online

Authorizations:
JWT
Request Body schema: application/json
required
phoneNumber
required
string

The phone number to verify. Must be in E.164 format.

callbackUrl
required
string <url>

Updates regarding the number verify transaction will be sent to the callback URL. It must begin with https://. See the Number verify state callback for the payload that is sent.

Responses

Request samples

Content type
application/json
{}

Response samples

Content type
application/json
{}

Retrieve number verify

Retrieve a single number verify transaction and its information

Authorizations:
JWT
path Parameters
transactionId
required
string <uuid>
Example: 6f8d0a9d-b85c-4c3f-9e69-5699f1e00f49

A unique identifier for the transaction.

Responses

Response samples

Content type
application/json
{
  • "id": "6f8d0a9d-b85c-4c3f-9e69-5699f1e00f49",
  • "state": "pending",
  • "match": true
}

Callbacks

Updates sent to the callbackUrl provided when requesting a number verify

Number verify state Webhook

Sent to the callbackUrl provided when requesting the number verify, every time the state of the number verify transaction changes. Use it as a trigger to retrieve the latest details with the Retrieve number verify endpoint.

The request is signed so you can verify its authenticity and integrity. The signature is calculated using HMAC-SHA256, with the request body as the message and the client secret as the secret key, and is sent in the Authorization header. Repeat this calculation on the received body and compare the result with the header value.

Respond with a status code in the 2xx range; the response body is ignored. When your endpoint responds with a 5xx status code, the callback is retried several times.

Authorizations:
HMAC
Request Body schema: application/json
required
id
required
string <uuid>

Unique identifier of the event.

type
required
string (EventType)
Value: "numberVerify.state"

Supported event types:

  • numberVerify.state - The number verify transaction has been updated.
created
required
string <date-time>

The time the event was created, in ISO 8601 format.

required
object

Responses

Request samples

Content type
application/json
{
  • "id": "58128784-9e8d-4424-a89d-08bfe273381c",
  • "type": "numberVerify.state",
  • "created": "2026-01-01T00:00:00+00:00",
  • "numberVerify": {
    }
}