Infobip Connectivity API
Powerful infrastructure and tools that connect you to the world.
Infobip Connectivity API is one of 6 APIs that Infobip publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include Connectivity. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.
This API exposes 35 operations across 27 paths, and defines 96 schemas. It is described by OpenAPI 3.2.0, at version 3.210.0.
Requests are made against the base URL https://api.infobip.com.
35 operations
27 paths
96 schemas
4 DELETE10 GET21 POST
Metadata
The identity and technical contract details declared by the specification.
Authentication & Security 4
Infobip Connectivity API declares
4 security schemes
for authenticating requests.
An API key is passed in the header as Authorization (APIKeyHeader).
It accepts HTTP basic authentication (Basic).
An API key is passed in the header as Authorization (IBSSOTokenHeader).
It supports OAuth 2.0 (OAuth2) using the clientCredentials flow.
APIKeyHeader— This is the most secure authorization type and the one with the most flexibility. API keys can be generated by calling the dedicated API method. Furthermore, A…Basic— Basic authorization type can be used in situations when the API key is not available. For example, API methods for generating API keys should be authenticated…IBSSOTokenHeader— This authorization type is suited for situations when you do not want to store Infobip credentials in your own app. Instead, your users will input their Infobi…OAuth2— Similarly to the IBSSO Token authentication you can use OAuth 2.0 bearer token with Infobip serving both as resource and authorization server. You can obtain t…
Paths & Operations 35
Across 27 paths, the API surfaces 35 operations — 4 DELETE, 10 GET, 21 POST. Each is listed below with its method, path, parameters, and response codes.
connectivity 35
Powerful infrastructure and tools that connect you to the world.
POST
/number/1/notify
Number Context lookup (async)
POST
/number/1/query
Number Context lookup
GET
/number/1/logs
Get Number Context logs
GET
/number-activation-state/1/network-reports
Get Network Reports metadata
GET
/number-activation-state/1/network-reports/{reportId}/records
Get Network Report content
POST
/mi/verification/1/verify
Silent Mobile Verification
POST
/mi/verification/1/verify/advanced
Advanced Silent Mobile Verification
POST
/mi/verification/1/verify/synchronousdeprecated
Synchronous Silent Mobile Verification
POST
/mi/verification/1/zero-rated/init
Zero rated request initialization
POST
/mi/verification/1/verify/zero-rated
Zero rated request verify
POST
/mi/number-intelligence/1/query
Number Intelligence
POST
/mi/simswap/1/check
SIM Swap
POST
/mi/national-identity-number/1/check
National Identity Number check
GET
/biometrics/1/scenarios
Get Scenarios
GET
/biometrics/1/extraction/sessions
Get Extraction Session
POST
/biometrics/1/extraction/sessions
Create Extraction Session
DELETE
/biometrics/1/extraction/sessions
Abort Extraction Session
GET
/biometrics/1/kyc/sessions
Get KYC Session
POST
/biometrics/1/kyc/sessions
Create KYC Session
DELETE
/biometrics/1/kyc/sessions
Abort KYC Session
GET
/biometrics/1/enrollment/sessions
Get Enrollment Session
POST
/biometrics/1/enrollment/sessions
Create Enrollment Session
DELETE
/biometrics/1/enrollment/sessions
Abort Enrollment Session
GET
/biometrics/1/verification/sessions
Get Verification Session
POST
/biometrics/1/verification/sessions
Create Verification Session
DELETE
/biometrics/1/verification/sessions
Abort Verification Session
GET
/camara/number-verification/v0/authorize
Number verify device authorization
POST
/camara/number-verification/v0/verify
Number Verification
POST
/camara/number-verification/v2/dcql
Number verification DCQL Request
GET
/camara/number-verification/v2/device-phone-number
Get Phone Number
POST
/camara/number-verification/v2/verify
Number Verification
POST
/camara/location/v0/verify
Device Location Verification
POST
/camara/sim-swap/v0/check
SIM Swap
POST
/camara/sim-swap/v0/retrieve-date
Retrieve SIM Swap date
POST
/camara/kyc-match/v0.3/match
KYC Match
Schemas 96
The contract defines 96 schemas that model the data the API accepts and returns. The most detailed are c4fb96364cd87b1d1d15720880c5153ef26f58342e4ec03b9d5896f2251f17ae.CamaraKycMatchResponseDto (32 properties), c4fb96364cd87b1d1d15720880c5153ef26f58342e4ec03b9d5896f2251f17ae.CamaraKycMatchRequestDto (20 properties), 8a19359d3a412667abbd2d38733e247b91417d2a845ae41758328736ea0ecce9.GenericSession (12 properties), eb583710b0e1739c1b6da279daf56e71bef92e0a50c90d88ff2c7fea69527204.MrzWebhookData (11 properties). Each schema is shown below with its type and property counts.
20085a4036d67f66ebf204560d55d58a7c131c15d42c8ed9442747c488e08630.NcResponseAsync
object
2 properties
c4fb96364cd87b1d1d15720880c5153ef26f58342e4ec03b9d5896f2251f17ae.NumberVerifyV2RequestDto
object
1 property
1 required
20085a4036d67f66ebf204560d55d58a7c131c15d42c8ed9442747c488e08630.NcLogPrice
object
2 properties
20085a4036d67f66ebf204560d55d58a7c131c15d42c8ed9442747c488e08630.NcResponseAsyncDetails
object
Collection of preliminary lookup results.
3 properties
8a19359d3a412667abbd2d38733e247b91417d2a845ae41758328736ea0ecce9.ScenarioDescription
object
Object containing scenario identifier and its description.
3 properties
8a19359d3a412667abbd2d38733e247b91417d2a845ae41758328736ea0ecce9.LocationInfo
object
End user location information.
2 properties
1 required
c4fb96364cd87b1d1d15720880c5153ef26f58342e4ec03b9d5896f2251f17ae.CamaraNotFoundErrorResponse
object
Camara API error response.
3 properties
8a19359d3a412667abbd2d38733e247b91417d2a845ae41758328736ea0ecce9.ExtractionSessionRequest
object
JSON containing session parameters and client identifiers for extraction application.
7 properties
3 required
c4fb96364cd87b1d1d15720880c5153ef26f58342e4ec03b9d5896f2251f17ae.DeviceLocationRequestDto
object
Check if provided MSISDN is in location defined by provided coordinates.
3 properties
eb583710b0e1739c1b6da279daf56e71bef92e0a50c90d88ff2c7fea69527204.EnrollmentWebhookRequest
object
4 properties
3 required
c33580c9fc909cbe636f10f5fddd71adf658d961011f6b0e7df8bbb45e9ab4cb.QueryResultResponse
object
Query result for each attribute sent to number intelligence query request
3 properties
c4fb96364cd87b1d1d15720880c5153ef26f58342e4ec03b9d5896f2251f17ae.NumberVerifyRequestDto
object
Number verification request object.
1 property
1 required
c4fb96364cd87b1d1d15720880c5153ef26f58342e4ec03b9d5896f2251f17ae.DltDto
object
Distributed Ledger Technology (DLT) specific parameters required for sending SMS to phone numbers registered in India.
2 properties
1 required
c4fb96364cd87b1d1d15720880c5153ef26f58342e4ec03b9d5896f2251f17ae.AttributesRequestDto
object
Object with parameters per attribute for Number Intelligence to query. Attribute value MUST NOT be null as in that case it will be ignored. In some cases where…
3 properties
20085a4036d67f66ebf204560d55d58a7c131c15d42c8ed9442747c488e08630.NcResponse
object
2 properties
c4fb96364cd87b1d1d15720880c5153ef26f58342e4ec03b9d5896f2251f17ae.SmvVerifySynchronousRequestDto
object
Silent Mobile Verification Synchronous request object.
4 properties
4 required
aaab91bc67ad6fdd15298ef61b480f76a93a7cae8c7684c83b1e909cda7f154f.ResultResponse
object
Advanced silent mobile verification request result
4 properties
c4fb96364cd87b1d1d15720880c5153ef26f58342e4ec03b9d5896f2251f17ae.CamaraDeviceLocationVerifyRequestDto
object
5 properties
4 required
c4fb96364cd87b1d1d15720880c5153ef26f58342e4ec03b9d5896f2251f17ae.SmsFailoverDto
object
SMS failover message contents. In case this field is null, no SMS failover will be done.
4 properties
2 required
eb583710b0e1739c1b6da279daf56e71bef92e0a50c90d88ff2c7fea69527204.VerificationWebhookRequest
object
4 properties
3 required
20085a4036d67f66ebf204560d55d58a7c131c15d42c8ed9442747c488e08630.NcStatus
object
6 properties
20085a4036d67f66ebf204560d55d58a7c131c15d42c8ed9442747c488e08630.NcQueryRequest
object
1 property
1 required
c4fb96364cd87b1d1d15720880c5153ef26f58342e4ec03b9d5896f2251f17ae.RegionalDto
object
Region specific parameters, often specified by local laws. Use this if country or region that you are sending SMS to requires some extra parameters.
1 property
c4fb96364cd87b1d1d15720880c5153ef26f58342e4ec03b9d5896f2251f17ae.SimSwapCheckRequestDto
object
SIM Swap request object.
3 properties
3 required
eb583710b0e1739c1b6da279daf56e71bef92e0a50c90d88ff2c7fea69527204.KycWebhookRequest
object
4 properties
3 required
20085a4036d67f66ebf204560d55d58a7c131c15d42c8ed9442747c488e08630.Network
object
Information about the roaming network.
5 properties
c4fb96364cd87b1d1d15720880c5153ef26f58342e4ec03b9d5896f2251f17ae.CamaraSimSwapRetrieveDateResponseDto
object
SIM swap retrieve date response object.
1 property
c4fb96364cd87b1d1d15720880c5153ef26f58342e4ec03b9d5896f2251f17ae.VerifyZeroRatedRequestDto
object
Silent Mobile Verification zero rated request verification.
1 property
8a19359d3a412667abbd2d38733e247b91417d2a845ae41758328736ea0ecce9.EnrollmentSessionRequest
object
JSON containing session parameters and client identifiers for Enrollment application.
7 properties
3 required
c4fb96364cd87b1d1d15720880c5153ef26f58342e4ec03b9d5896f2251f17ae.ErrorDto
objectnull
Error object describing occurred error, present only if an error has occurred.
3 properties
c4fb96364cd87b1d1d15720880c5153ef26f58342e4ec03b9d5896f2251f17ae.DcqlRequestDto
object
4 properties
3 required
c4fb96364cd87b1d1d15720880c5153ef26f58342e4ec03b9d5896f2251f17ae.Claim
object
Claim object containing the optional hint used by Android to suggest the right SIM in dual-SIM devices.
2 properties
4033c81feb806caaa02f9cef553f79f0137a7aaa85d200d9d5e6449874c43c3d.NcLogResponse
object
1 property
8a19359d3a412667abbd2d38733e247b91417d2a845ae41758328736ea0ecce9.BiometricData
object
Biometric data.
8018948352e80bbff88731d9fb43f611b84a58f2b44c304c63a8e4ae9c4bd661.ReportMetadata
object
7 properties
7 required
8a19359d3a412667abbd2d38733e247b91417d2a845ae41758328736ea0ecce9.KycSessionRequest
object
JSON containing session parameters and client identifiers for KYC application.
7 properties
3 required
8a19359d3a412667abbd2d38733e247b91417d2a845ae41758328736ea0ecce9.GenericSession
object
Session object.
12 properties
3 required
eb583710b0e1739c1b6da279daf56e71bef92e0a50c90d88ff2c7fea69527204.ExtractionWebhookData
object
Result data object.
1 property
eb583710b0e1739c1b6da279daf56e71bef92e0a50c90d88ff2c7fea69527204.ExtractionWebhookRequest
object
4 properties
3 required
c4fb96364cd87b1d1d15720880c5153ef26f58342e4ec03b9d5896f2251f17ae.CamaraSimSwapRetrieveDateRequestDto
object
1 property
1 required
c4fb96364cd87b1d1d15720880c5153ef26f58342e4ec03b9d5896f2251f17ae.SmvVerifyRequestDto
object
Silent Mobile Verification request object.
6 properties
3 required
c4fb96364cd87b1d1d15720880c5153ef26f58342e4ec03b9d5896f2251f17ae.CamaraSimSwapCheckRequestDto
object
2 properties
1 required
c4fb96364cd87b1d1d15720880c5153ef26f58342e4ec03b9d5896f2251f17ae.Meta
object
2 properties
20085a4036d67f66ebf204560d55d58a7c131c15d42c8ed9442747c488e08630.NcNotifyRequest
object
3 properties
1 required
c4fb96364cd87b1d1d15720880c5153ef26f58342e4ec03b9d5896f2251f17ae.NiQueryRequestDto
object
Number Intelligence query request object.
4 properties
4 required
4033c81feb806caaa02f9cef553f79f0137a7aaa85d200d9d5e6449874c43c3d.NcLog
object
Collection of logs.
9 properties
c4fb96364cd87b1d1d15720880c5153ef26f58342e4ec03b9d5896f2251f17ae.NumberVerifyResponseDto
object
Number verification response object.
1 property
c4fb96364cd87b1d1d15720880c5153ef26f58342e4ec03b9d5896f2251f17ae.DcqlResponseDto
object
Map of resolved DCQL credential objects keyed by carrier ID, used to build the credential request structure for the Android CredentialManager (TS.43 SIM-based…
8018948352e80bbff88731d9fb43f611b84a58f2b44c304c63a8e4ae9c4bd661.DeactivationType
string
Type of the activation information. Potential values are: DEACTIVATION - number was deactivated. All messaging to this number must stop. ACTIVATION - number wa…
c4fb96364cd87b1d1d15720880c5153ef26f58342e4ec03b9d5896f2251f17ae.CamaraResponseBaseDto
object
20085a4036d67f66ebf204560d55d58a7c131c15d42c8ed9442747c488e08630.NcResponseDetails
object
Collection of lookup results.
11 properties
c4fb96364cd87b1d1d15720880c5153ef26f58342e4ec03b9d5896f2251f17ae.NationalIdentityNumberDto
object
Check if provided MSISDN belongs to user with provided national identity number.
2 properties
8018948352e80bbff88731d9fb43f611b84a58f2b44c304c63a8e4ae9c4bd661.PageReportMetadata
object
2 properties
c4fb96364cd87b1d1d15720880c5153ef26f58342e4ec03b9d5896f2251f17ae.ServiceException
object
Service exception object containing error details.
2 properties
c4fb96364cd87b1d1d15720880c5153ef26f58342e4ec03b9d5896f2251f17ae.CamaraSimSwapCheckResponseDto
object
SIM swap check response object.
1 property
8a19359d3a412667abbd2d38733e247b91417d2a845ae41758328736ea0ecce9.BiometricVector
object
c4fb96364cd87b1d1d15720880c5153ef26f58342e4ec03b9d5896f2251f17ae.SimSwapRequestDto
object
Check if sim swap has occurred for requested MSISDN in provided time period.
1 property
c4fb96364cd87b1d1d15720880c5153ef26f58342e4ec03b9d5896f2251f17ae.CamaraPermissionDeniedErrorResponse
object
Camara API error response for permission denied requests.
3 properties
8a19359d3a412667abbd2d38733e247b91417d2a845ae41758328736ea0ecce9.ScenarioResponse
object
1 property
c4fb96364cd87b1d1d15720880c5153ef26f58342e4ec03b9d5896f2251f17ae.SimSwapCheckDto
object
SIM swap check parameters. In case this field is null, no SIM swap checks will be done.
2 properties
1 required
eb583710b0e1739c1b6da279daf56e71bef92e0a50c90d88ff2c7fea69527204.MrzWebhookData
object
Results of reading Machine Readable Zone (MRZ) data.
11 properties
8a19359d3a412667abbd2d38733e247b91417d2a845ae41758328736ea0ecce9.GetSessionResponse
object
JSON containing execution results and details about the retrieved session.
1 property
20085a4036d67f66ebf204560d55d58a7c131c15d42c8ed9442747c488e08630.NcError
object
6 properties
c4fb96364cd87b1d1d15720880c5153ef26f58342e4ec03b9d5896f2251f17ae.MatchResult
string
c4fb96364cd87b1d1d15720880c5153ef26f58342e4ec03b9d5896f2251f17ae.PlatformErrorResponse
object
Platform error response for authentication and authorization errors.
1 property
c4fb96364cd87b1d1d15720880c5153ef26f58342e4ec03b9d5896f2251f17ae.SimSwapProceedOnDto
string
If specified, proceed to the SMV verify in case: - SIM swap check fails - There is no SIM swap coverage - Result of the SIM swap check was unknown
8018948352e80bbff88731d9fb43f611b84a58f2b44c304c63a8e4ae9c4bd661.PageReports
object
2 properties
acc54cffc2fdf57be1405002c65f11d7bb0b2506a15f7e1c75bb3cbcc41d6219.ResultResponse
object
Silent mobile verification request result
3 properties
c4fb96364cd87b1d1d15720880c5153ef26f58342e4ec03b9d5896f2251f17ae.DcqlNotFoundErrorResponse
object
Map of DCQL error responses keyed by carrier ID, returned when one or more requested carriers could not be resolved. Resolved carriers will be returned in the…
20085a4036d67f66ebf204560d55d58a7c131c15d42c8ed9442747c488e08630.MessageGeneralStatus
string
Status group name that describes which category the status code belongs to, i.e., [PENDING](https://www.infobip.com/docs/essentials/response-status-and-error-c…
c4fb96364cd87b1d1d15720880c5153ef26f58342e4ec03b9d5896f2251f17ae.CamaraUserEquipmentIdentifierDto
object
User equipment identifier.
4 properties
1 required
8a19359d3a412667abbd2d38733e247b91417d2a845ae41758328736ea0ecce9.WebhookInfo
object
Webhook that will be called with the information about the request status. The webhook will be called with a POST method that contains all the info in JSON for…
2 properties
1 required
c4fb96364cd87b1d1d15720880c5153ef26f58342e4ec03b9d5896f2251f17ae.RequestError
object
Request error object.
1 property
c4fb96364cd87b1d1d15720880c5153ef26f58342e4ec03b9d5896f2251f17ae.CamaraKycMatchRequestDto
object
Camara Know Your Customer Match request object
20 properties
1 required
ApiRequestError
object
1 property
eb583710b0e1739c1b6da279daf56e71bef92e0a50c90d88ff2c7fea69527204.VerificationWebhookData
object
Result data object.
3 properties
c4fb96364cd87b1d1d15720880c5153ef26f58342e4ec03b9d5896f2251f17ae.Ts43UseCase
string
The TS.43 operation use case.
578c889dd8f68587bd351066c5c6572a98ea0c15c65b5cacb8779be90fbfbb70.ApiException
object
1 property
c4fb96364cd87b1d1d15720880c5153ef26f58342e4ec03b9d5896f2251f17ae.DevicePhoneNumberResponseDto
object
Device phone number response object.
1 property
c4fb96364cd87b1d1d15720880c5153ef26f58342e4ec03b9d5896f2251f17ae.CamaraKycMatchResponseDto
object
Camara Know Your Customer Match response object
32 properties
eb583710b0e1739c1b6da279daf56e71bef92e0a50c90d88ff2c7fea69527204.KycWebhookData
object
Result data object.
6 properties
c4fb96364cd87b1d1d15720880c5153ef26f58342e4ec03b9d5896f2251f17ae.DcqlCredentialPerCarrierDtoResponse
object
DCQL credential object per carrier.
4 properties
8018948352e80bbff88731d9fb43f611b84a58f2b44c304c63a8e4ae9c4bd661.ReportLineItem
object
4 properties
3 required
ApiRequestErrorDetails
object
3 properties
8a19359d3a412667abbd2d38733e247b91417d2a845ae41758328736ea0ecce9.CreatedSessionResponse
object
JSON containing information about the new session.
2 properties
c4fb96364cd87b1d1d15720880c5153ef26f58342e4ec03b9d5896f2251f17ae.InitZeroRatedRequestDto
object
Silent Mobile Verification zero rated request initialization.
3 properties
2 required
c4fb96364cd87b1d1d15720880c5153ef26f58342e4ec03b9d5896f2251f17ae.OperationType
string
eb583710b0e1739c1b6da279daf56e71bef92e0a50c90d88ff2c7fea69527204.EnrollmentWebhookData
object
Result data object.
2 properties
8a19359d3a412667abbd2d38733e247b91417d2a845ae41758328736ea0ecce9.VerificationSessionRequest
object
JSON containing session parameters and client identifiers for Verification application.
8 properties
3 required
ApiException
object
1 property
c4fb96364cd87b1d1d15720880c5153ef26f58342e4ec03b9d5896f2251f17ae.SmvVerifyAdvancedRequestDto
object
Silent Mobile Verification Advanced request object.
8 properties
3 required
8018948352e80bbff88731d9fb43f611b84a58f2b44c304c63a8e4ae9c4bd661.PageInfo
object
4 properties
4 required
c4fb96364cd87b1d1d15720880c5153ef26f58342e4ec03b9d5896f2251f17ae.NinCheckRequestDto
object
National Identity Number check request object.
4 properties
3 required
c4fb96364cd87b1d1d15720880c5153ef26f58342e4ec03b9d5896f2251f17ae.CamaraUnauthenticatedErrorResponse
object
Camara API error response for unauthenticated requests.
3 properties
8a19359d3a412667abbd2d38733e247b91417d2a845ae41758328736ea0ecce9.BiometricReference
object
4503c9be2d8553d1e8648e283b9ba9017ae14f51177b500d7b5df7dc4842e4d2.ErrorInfoResponse
object
Information about error occurred. If there is no error this object is omitted.
3 properties
Specification
The full machine-readable OpenAPI contract behind this narrative.
Source
More from Infobip 5
Other APIs Infobip publishes across the network.
Infobip AI Hub API
Infobip Channels API
Infobip Customer Engagement API
Infobip Platform API
Infobip Tools API
#Connectivity
Where this information came from
This is an independent, third-party profile of Infobip Connectivity API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.
The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.
Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.
info@apievangelist.com
·
Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and
you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.