Skip to content

Commit

Permalink
Link API references from guides
Browse files Browse the repository at this point in the history
  • Loading branch information
diegotid committed Sep 3, 2024
1 parent 2baf3f7 commit c04b735
Show file tree
Hide file tree
Showing 3 changed files with 53 additions and 37 deletions.
30 changes: 19 additions & 11 deletions catalog/numberverification/numberverification.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,26 +6,34 @@ category: 66aa4f941e51e7000fa353ce

Built as part of the Open Gateway initiative, the Number Verification API provides developers universal access to essential network functionalities. Whether you're enhancing user registration processes, securing transactions, or optimizing user engagement strategies, integrating the Number Verification API enriches your application's security posture while ensuring a seamless user experience.

## Why Number Verification?

In today's digital landscape, verifying phone number ownership is critical to prevent identity fraud and secure online transactions. The Number Verification CAMARA API offers a reliable solution to **authenticate users by confirming their phone numbers**. This ensures that only legitimate users gain access to digital services, bolstering security measures and building trust among customers.

### How does the Number Verification API help to facilitate authentication?
## Overview of the Number Verification CAMARA API

The Number Verification API utilizes telco mechanisms to authenticate users seamlessly based on their device's connection to the network. This method contrasts with traditional authentication solutions by enhancing user convenience and security. Unlike manual processes or plain-text codes, network-based validation requires no user interaction, bolstering protection against unauthorized access.

This API verifies that the provided mobile phone number (MSISDN) matches the device initiating data communication, ensuring users interact with digital services from authenticated devices.
### High level definition

# Overview of the Number Verification CAMARA API
The Number Verification CAMARA API validates user identity by confirming ownership of the phone number being registered, matching it with the number identified by the operator through the user’s device connection.

## High level definition of the Number Verification CAMARA API
### API Operations

The Number Verification CAMARA API validates user identity by confirming ownership of the phone number being registered, matching it with the number identified by the operator through the user’s device connection. It facilitates two primary operations:
The Number Verification CAMARA API specifies the following two operations:

- **POST verify:** Determines if the provided phone number matches the one currently in use by the user (parameter `phoneNumber`). This operation is ideal for user authentication.

[Check the API Reference](/reference/phonenumberverify)

- **GET device-phone-number:** Identifies the phone number currently associated with the user's device without requiring input, providing a straightforward way to retrieve this information.

***Pending for availability***

The Number Verification CAMARA API enables developers to seamlessly integrate authentication mechanisms into their applications, enhancing the user experience and security. It can also be combined with other Open Gateway APIs focused on anti-fraud measures to further bolster security.

Integration with channel partners and service aggregators streamlines the incorporation of telco functionalities with additional security algorithms, backup authentication methods, or external data sources. This collaboration enhances service reliability and security, leveraging APIs like Device Location Verification or SIM SWAP within the Open Gateway framework.

## Why Number Verification?

In today's digital landscape, verifying phone number ownership is critical to prevent identity fraud and secure online transactions. The Number Verification CAMARA API offers a reliable solution to **authenticate users by confirming their phone numbers**. This ensures that only legitimate users gain access to digital services, bolstering security measures and building trust among customers.

### How does the Number Verification API help to facilitate authentication?

The Number Verification API utilizes telco mechanisms to authenticate users seamlessly based on their device's connection to the network. This method contrasts with traditional authentication solutions by enhancing user convenience and security. Unlike manual processes or plain-text codes, network-based validation requires no user interaction, bolstering protection against unauthorized access.

This API verifies that the provided mobile phone number (MSISDN) matches the device initiating data communication, ensuring users interact with digital services from authenticated devices.
12 changes: 8 additions & 4 deletions catalog/roadmap.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,26 +10,30 @@ The following APIs are already available on most telcos' API exposure platforms,

Get sure to get onboarded on the Open Gateway Developer Hub to get early access to these APIs and start testing them in our <a href="/docs/sandbox">Sandbox environment</a>.

### Number Verification API

The standardized Number Verification API enhances the security of your users' identities and credentials. This API provides a quick, convenient, reliable, and secure method for verifying user information, ensuring robust protection against unauthorized access.

### Device location

The standardised Device Location Verification API provides the option of verifying the geographical location of a given SIM-based device and validating whether it is within a requested geographical area without spoofing or GPS.

This solution validates the location of a device to enable services or allow transactions by verifying the location.

[Check the API Reference](/reference/verifylocation-1)

### Device status

The standardised Device Status API provides information regarding particular conditions of devices equipped with the end-user's SIM card, such as whether the device is in a roaming state and the country it is in.

Again, this API enables use cases around specific services related to the end-user's situation, or preventing frauds from foreign locations.

[Check the API Reference](/reference/getroamingstatus)

### Quality on Demand Mobile (QoD Mobile) API

The standardized QoD Mobile API allows you to manage and control your customers' mobile connectivity. This capability enables you to focus on creating the best possible user experiences, ensuring optimal performance and reliability for mobile applications.

***Pending for availability***

### Home Devices Quality on Demand (QoD WiFi) API

The standardized Home Devices QoD API lets you configure and manage the quality of service for devices connected to a single Wi-Fi network. This API enhances the user experience for digital services within the home by providing greater control over the quality of service on demand. It is especially useful for technologies such as virtual reality, augmented reality, cloud gaming, and voice over IP.

***Pending for availability***
48 changes: 26 additions & 22 deletions catalog/simswap/simswap.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,29 +8,9 @@ The standardized SIM Swap API enables seamless integration of SIM swap detection

Additionally, the SIM Swap's Unified API Access feature ensures access to network capabilities of various carriers through a single, standardized interface. This simplifies integration and improves efficiency for developers by consolidating access to multiple carrier networks.

## SIM Swap and Account Takeover Fraud

### Understanding SIM Swap Fraud
## Overview of the SIM Swap CAMARA API

SIM Swap is a serious form of account takeover fraud. Your mobile phone is the most common device used to manage a wide range of products and services – from food delivery or gym accounts to car insurance or bank accounts. Each of these services requires a personal account to perform various transactions.

Account takeover fraud is one of the most impactful types of cybercrime. When a fraudster gains control of a user's account, they can exploit all the functionalities associated with that account. The quickest way to monetize this fraud is by transferring money or making purchases. However, other severe consequences can occur, such as implicating the real customer in criminal activities.

### How SIM Cards are Used by Telecom Operators

A SIM card is a small card inside your mobile phone, identified by a unique number. Telecom operators maintain a link between this number and your phone number. If your phone number is linked to a different SIM card, phone calls and SMS messages intended for you will be redirected to another mobile phone.

This is where SIM swap fraud becomes dangerous. The "new" mobile phone can be used to reset passwords and validate fraudulent transactions. Essentially, this allows the fraudster to take over your accounts and misuse them for malicious purposes.

### Protecting Against SIM Swap Fraud

To safeguard against SIM swap fraud, it is crucial to be aware of how your personal and financial information is used and protected. Use strong, unique passwords for your accounts, enable two-factor authentication, and monitor your accounts for any suspicious activity. Always be cautious of unsolicited requests for personal information, whether over the phone, via SMS, or through email.

By understanding the mechanics of SIM swap fraud and taking proactive steps to protect your accounts, you can significantly reduce the risk of falling victim to this type of cybercrime.

# Overview of the SIM Swap CAMARA API

## High level definition of the SIM Swap CAMARA API
### High level definition

The SIM Swap CAMARA API is a software interface that enables applications to request the last date of a SIM swap performed on a mobile line or to check whether a SIM swap has been performed during a specified period. This functionality is provided in an easy and secure manner, allowing real-time verification of the activation date of a SIM card on the mobile network.

Expand All @@ -40,12 +20,36 @@ The SIM Swap CAMARA API specifies the following two operations:

- **POST retrieve-date:** Answers the question ‘when did the last SIM swap occur?’. This operation requires the phone number to be checked (parameter `phoneNumber`).

[Check the API Reference](/reference/retrievesimswapdate)

- **POST check:** Checks whether a SIM swap occurred during the last N hours. This operation requires the following inputs:
- `phoneNumber`: The phone number to be checked.
- `maxAge`: The period in hours to be checked for a SIM swap (minimum 1 hour, maximum 2400 hours, default 240 hours).

[Check the API Reference](/reference/checksimswap)

With the SIM Swap CAMARA API, any digital service provider can integrate the functionality of checking changes in SIM renewals directly into their software. This can be done both alone and in combination with other external inputs. Additionally, they can combine other Open Gateway APIs related to anti-fraud measures that may be of interest.

Aggregators play a crucial role in the anti-fraud industry. They can integrate this functionality into their software and build more sophisticated algorithms by combining other security checks, such as location verification, phone number verification, matching of contact information, external data sources, AI algorithms, etc. To achieve this, aggregators can use other Open Gateway APIs like Device Location Verification, Number Verification, or KYC-Match.

By using the SIM Swap CAMARA API, developers can significantly enhance the security and reliability of their applications, providing a robust defense against SIM swap fraud.

## SIM Swap and Account Takeover Fraud

### Understanding SIM Swap Fraud

SIM Swap is a serious form of account takeover fraud. Your mobile phone is the most common device used to manage a wide range of products and services – from food delivery or gym accounts to car insurance or bank accounts. Each of these services requires a personal account to perform various transactions.

Account takeover fraud is one of the most impactful types of cybercrime. When a fraudster gains control of a user's account, they can exploit all the functionalities associated with that account. The quickest way to monetize this fraud is by transferring money or making purchases. However, other severe consequences can occur, such as implicating the real customer in criminal activities.

### How SIM Cards are Used by Telecom Operators

A SIM card is a small card inside your mobile phone, identified by a unique number. Telecom operators maintain a link between this number and your phone number. If your phone number is linked to a different SIM card, phone calls and SMS messages intended for you will be redirected to another mobile phone.

This is where SIM swap fraud becomes dangerous. The "new" mobile phone can be used to reset passwords and validate fraudulent transactions. Essentially, this allows the fraudster to take over your accounts and misuse them for malicious purposes.

### Protecting Against SIM Swap Fraud

To safeguard against SIM swap fraud, it is crucial to be aware of how your personal and financial information is used and protected. Use strong, unique passwords for your accounts, enable two-factor authentication, and monitor your accounts for any suspicious activity. Always be cautious of unsolicited requests for personal information, whether over the phone, via SMS, or through email.

By understanding the mechanics of SIM swap fraud and taking proactive steps to protect your accounts, you can significantly reduce the risk of falling victim to this type of cybercrime.

0 comments on commit c04b735

Please sign in to comment.