---
title: "Number Intelligence"
method: POST
path: "/mi/number-intelligence/1/query"
tags: ["connectivity", "mobile-identity", "identity-number-intelligence"]
---

# Number Intelligence

`POST /mi/number-intelligence/1/query`

## Request

- Base URL: `https://api.infobip.com` (the document declares no server; this is the origin it was published from)
- URL: `https://api.infobip.com/mi/number-intelligence/1/query`
- Auth: one of:
  - OAuth 2
    - Client credentials
    - Token URL: `https://api.infobip.com/auth/1/oauth2/token`
  - API key in header `Authorization`
  - API key in header `Authorization`
  - HTTP basic

Use this method to perform a query by a mobile phone number (MSISDN) for a given attribute name.
API and URL may vary per country. Contact your Account Manager for implementation details.

## Request body

- C4fb96364cd87b1d1d15720880c5153ef26f58342e4ec03b9d5896f2251f17aeNiQueryRequestDto: Number Intelligence query request object.
  - `consentGranted` boolean, required: Indicates whether you have consent from mobile phone number's owner to perform this request. All requests that do not have this property set to "true" will be rejected.
  - `phoneNumber` string, required: Mobile phone number (MSISDN) to perform a query by. The number must be in international format.
  - `callbackUrl` string, required: Your URL that will be called to provide [query results](#platform-connectivity/mobile-identity/receive-number-intelligence-query-results) when the process is completed.
  - `attributes` C4fb96364cd87b1d1d15720880c5153ef26f58342e4ec03b9d5896f2251f17aeAttributesRequestDto, required: Object with parameters per attribute for Number Intelligence to query.<br/> Attribute value <strong>MUST NOT</strong> be <strong>null</strong> as in that case it will be ignored.<br/> In some cases where attribute value has no parameters it <strong>NEEDS TO BE</strong> an empty object.
    - `simSwap` C4fb96364cd87b1d1d15720880c5153ef26f58342e4ec03b9d5896f2251f17aeSimSwapRequestDto: Check if sim swap has occurred for requested MSISDN in provided time period.
      - `period` integer: If SIM swap attribute is included it will be verified with MNO allowed hour period. The value should be greater than 0.
    - `nationalIdentityNumber` C4fb96364cd87b1d1d15720880c5153ef26f58342e4ec03b9d5896f2251f17aeNationalIdentityNumberDto: Check if provided MSISDN belongs to user with provided national identity number.
      - `nationalId` string: National Identification Number that will be used to check for a match against a mobile phone number.
      - `documentType` string: Document type that will be used to check for a match against a mobile phone number. Currently, used and mandatory only in Colombia. Available values are `CC`, `CE` and `NIT`.
    - `deviceLocation` C4fb96364cd87b1d1d15720880c5153ef26f58342e4ec03b9d5896f2251f17aeDeviceLocationRequestDto: Check if provided MSISDN is in location defined by provided coordinates.
      - `latitude` number, float: Latitude that will be used to check for location of a mobile phone for provided phone number.
      - `longitude` number, float: Longitude that will be used to check for location of a mobile phone for provided phone number.
      - `accuracy` integer: Accuracy in km that will be used to check for location of a mobile phone for provided phone number.

## Response `200`

OK

- object
  - `token` string, uuid: Unique request identifier.

## Other responses

- `400`: Bad request
- `401`: Unauthorized - Platform authentication error
- `403`: Permission denied - Platform authorization error
- `422`: Unprocessable content
- `500`: Internal server error

---

[API](https://skmtc.dev/infobip/apis/infobip-openapi-specification.md) - [All operations](https://skmtc.dev/infobip/apis/infobip-openapi-specification/llms.txt) - [OpenAPI document](https://skmtc.dev/infobip/apis/infobip-openapi-specification/revisions/9dcbbaf902de?raw)