Skip to content

Commit 676d812

Browse files
committed
Remove guides content duplicating references
1 parent 57990ff commit 676d812

File tree

5 files changed

+0
-226
lines changed

5 files changed

+0
-226
lines changed

v0/catalog/devicelocation/devicelocation.md

Lines changed: 0 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -65,28 +65,3 @@ As a standardized API, it allows seamless integration into your applications wit
6565

6666
### Footprint for your identity service
6767
The API's standardization ensures uniform access across multiple telecom providers, expanding your business reach and ensuring consistent functionality across different carriers.
68-
69-
## General Informations
70-
71-
> ⚙️ Problem Solved
72-
>
73-
> You want to verify that a device is where you expect it to be. The expected location can be the reported GPS coordinates, safe places to operate from (e.g. home address, workplace), etc.
74-
75-
76-
> ⚙️ How it works
77-
>
78-
> By providing latitude and longitude, it is checked whether the device is in that location.
79-
80-
81-
> ⚙️ Parameters sent in the request
82-
>
83-
> - msisdn (mobile phone number in the format: +551199999999)
84-
> - latitude (latitude in the format: -23.5042623)
85-
> - longitude (longitude in the format -46.8575631)
86-
> - accuracy (precision of the radius of the circle in km: 2)
87-
88-
89-
> ⚙️ Data received in the response
90-
>
91-
> If the device is not in the expected location, it returns verificationResult: false . If the device is in the expected location, the value is verificationResult: true .
92-

v0/catalog/devicestatus/devicestatus.md

Lines changed: 0 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -66,23 +66,3 @@ Since it is a standardized API, integration is straightforward and doesn’t req
6666
### Unified Access to Telecom Functions
6767

6868
The standardized API provides uniform access to other telecom capabilities, such as detecting if a user is roaming, through a single interface. This ensures consistency and flexibility across different carriers and markets.
69-
70-
71-
## General Informations
72-
73-
> ⚙️ Problem Solved ?
74-
>
75-
> Check if a device is roaming or not.
76-
77-
78-
> ⚙️ Parameters sent in the request
79-
>
80-
> - msisdn (mobile phone number in the format - +551199999999)
81-
> - eventType (Select the various events - In one of these patterns: ROAMING_STATUS or ROAMING_ON or ROAMING_OFF or ROAMING_CHANGE_COUNTRY )
82-
83-
84-
> ⚙️ Data received in the response
85-
>
86-
> - If the device is roaming, it returns "roaming": true ;
87-
> - If the device is not roaming, returns "roaming": false.
88-

v0/catalog/knowyourcustomer/knowyourcustomer.md

Lines changed: 0 additions & 113 deletions
Original file line numberDiff line numberDiff line change
@@ -58,116 +58,3 @@ By using a standardized API, you can effortlessly incorporate the KYC-Match proc
5858
### Footprint for your Identify Service​
5959

6060
The standardized API provides uniform access to multiple telecom companies, broadening your business reach and ensuring consistent and flexible operations across different providers.
61-
62-
63-
64-
## General Informations
65-
66-
> ⚙️ Problem Solved ?
67-
>
68-
> Check if the user data is true or false.
69-
70-
71-
> ⚙️ Parameters sent in the request
72-
>
73-
> - idDocumentMatch (Indicates whether the ID number associated with the customer's ID document matches the one in the OB systems. Possible values: true, false, not_available)
74-
> - nameMatch (Indicates whether the customer's full name matches the one in the OB systems. Possible values: true, false, not_available)
75-
> - givenNameMatch (Indicates whether the customer's first name matches the one in the OB systems. Possible values: true, false, not_available)
76-
> - familyNameMatch (Indicates whether the customer's last name matches the one in the OB systems. Possible values: true, false, not_available)
77-
> - nameKanaHankakuMatch (Indicates whether the customer's full name in Hankaku-Kana format (name reading) for Japan matches the one in the OB systems. Possible values: true, false, not_available)
78-
> - nameKanaZenkakuMatch (Indicates whether the customer's full name in Zenkaku-Kana format (name reading) for Japan matches the one in the OB systems. Possible values: true, false, not_available)
79-
> - middleNamesMatch (Indicates whether the customer's middle names match the ones in the OB systems. Possible values: true, false, not_available)
80-
> - familyNameAtBirthMatch (Indicates whether the customer's family name at birth matches the one in the OB systems. Possible values: true, false, not_available)
81-
> - addressMatch (Indicates whether the customer's complete address matches the one in the OB systems. Possible values: true, false, not_available)
82-
> - streetNameMatch (Indicates whether the customer's street name matches the one in the OB systems. Possible values: true, false, not_available)
83-
> - streetNumberMatch (Indicates whether the customer's street number matches the one in the OB systems. Possible values: true, false, not_available)
84-
> - postalCodeMatch (Indicates whether the customer's postal code matches the one in the OB systems. Possible values: true, false, not_available)
85-
> - regionMatch (Indicates whether the region of the customer's address matches the one in the OB systems. Possible values: true, false, not_available)
86-
> - localityMatch (Indicates whether the locality of the customer's address matches the one in the OB systems. Possible values: true, false, not_available)
87-
> - countryMatch (Indicates whether the country of the customer's address matches the one in the OB systems. Possible values: true, false, not_available)
88-
> - houseNumberExtensionMatch (Indicates whether the house number extension of the customer's address matches the one in the OB systems. Possible values: true, false, not_available)
89-
> - birthdateMatch (Indicates whether the customer's birthdate matches the one in the OB systems. Possible values: true, false, not_available)
90-
> - emailMatch (Indicates whether the customer's email address matches the one in the OB systems. Possible values: true, false, not_available)
91-
> - genderMatch (Indicates whether the customer's gender matches the one in the OB systems. Possible values: true, false, not_available)
92-
93-
94-
95-
> ⚙️ Data received in the response
96-
>
97-
> - If the ID number associated with the customer's ID document matches the one in the OB systems, it returns "idDocumentMatch": true;
98-
> - If the ID number does not match, it returns "idDocumentMatch": false;
99-
> - If the ID number is not available, it returns "idDocumentMatch": not_available.
100-
101-
> - If the customer's full name matches the one in the OB systems, it returns "nameMatch": true;
102-
> - If the full name does not match, it returns "nameMatch": false;
103-
> - If the full name is not available, it returns "nameMatch": not_available.
104-
105-
> - If the customer's first name matches the one in the OB systems, it returns "givenNameMatch": true;
106-
> - If the first name does not match, it returns "givenNameMatch": false;
107-
> - If the first name is not available, it returns "givenNameMatch": not_available.
108-
109-
> - If the customer's last name matches the one in the OB systems, it returns "familyNameMatch": true;
110-
> - If the last name does not match, it returns "familyNameMatch": false;
111-
> - If the last name is not available, it returns "familyNameMatch": not_available.
112-
113-
> - If the customer's full name in Hankaku-Kana format (name reading) for Japan matches the one in the OB systems, it returns "nameKanaHankakuMatch": true;
114-
> - If the full name in Hankaku-Kana format does not match, it returns "nameKanaHankakuMatch": false;
115-
> - If the full name in Hankaku-Kana format is not available, it returns "nameKanaHankakuMatch": not_available.
116-
117-
> - If the customer's full name in Zenkaku-Kana format (name reading) for Japan matches the one in the OB systems, it returns "nameKanaZenkakuMatch": true;
118-
> - If the full name in Zenkaku-Kana format does not match, it returns "nameKanaZenkakuMatch": false;
119-
> - If the full name in Zenkaku-Kana format is not available, it returns "nameKanaZenkakuMatch": not_available.
120-
121-
> - If the customer's middle names match the ones in the OB systems, it returns "middleNamesMatch": true;
122-
> - If the middle names do not match, it returns "middleNamesMatch": false;
123-
> - If the middle names are not available, it returns "middleNamesMatch": not_available.
124-
125-
> - If the customer's family name at birth matches the one in the OB systems, it returns "familyNameAtBirthMatch": true;
126-
> - If the family name at birth does not match, it returns "familyNameAtBirthMatch": false;
127-
> - If the family name at birth is not available, it returns "familyNameAtBirthMatch": not_available.
128-
129-
> - If the customer's complete address matches the one in the OB systems, it returns "addressMatch": true;
130-
> - If the complete address does not match, it returns "addressMatch": false;
131-
> - If the complete address is not available, it returns "addressMatch": not_available.
132-
133-
> - If the customer's street name matches the one in the OB systems, it returns "streetNameMatch": true;
134-
> - If the street name does not match, it returns "streetNameMatch": false;
135-
> - If the street name is not available, it returns "streetNameMatch": not_available.
136-
137-
> - If the customer's street number matches the one in the OB systems, it returns "streetNumberMatch": true;
138-
> - If the street number does not match, it returns "streetNumberMatch": false;
139-
> - If the street number is not available, it returns "streetNumberMatch": not_available.
140-
141-
> - If the customer's postal code matches the one in the OB systems, it returns "postalCodeMatch": true;
142-
> - If the postal code does not match, it returns "postalCodeMatch": false;
143-
> - If the postal code is not available, it returns "postalCodeMatch": not_available.
144-
145-
> - If the region of the customer's address matches the one in the OB systems, it returns "regionMatch": true;
146-
> - If the region does not match, it returns "regionMatch": false;
147-
> - If the region is not available, it returns "regionMatch": not_available.
148-
149-
> - If the locality of the customer's address matches the one in the OB systems, it returns "localityMatch": true;
150-
> - If the locality does not match, it returns "localityMatch": false;
151-
> - If the locality is not available, it returns "localityMatch": not_available.
152-
153-
> - If the country of the customer's address matches the one in the OB systems, it returns "countryMatch": true;
154-
> - If the country does not match, it returns "countryMatch": false;
155-
> - If the country is not available, it returns "countryMatch": not_available.
156-
157-
> - If the house number extension of the customer's address matches the one in the OB systems, it returns "houseNumberExtensionMatch": true;
158-
> - If the house number extension does not match, it returns "houseNumberExtensionMatch": false;
159-
> - If the house number extension is not available, it returns "houseNumberExtensionMatch": not_available.
160-
161-
> - If the customer's birthdate matches the one in the OB systems, it returns "birthdateMatch": true;
162-
> - If the birthdate does not match, it returns "birthdateMatch": false;
163-
> - If the birthdate is not available, it returns "birthdateMatch": not_available.
164-
165-
> - If the customer's email address matches the one in the OB systems, it returns "emailMatch": true;
166-
> - If the email address does not match, it returns "emailMatch": false;
167-
> - If the email address is not available, it returns "emailMatch": not_available.
168-
169-
> - If the customer's gender matches the one in the OB systems, it returns "genderMatch": true;
170-
> - If the gender does not match, it returns "genderMatch": false;
171-
> - If the gender is not available, it returns "genderMatch": not_available.
172-
173-

v0/catalog/numberverification/numberverification.md

Lines changed: 0 additions & 37 deletions
Original file line numberDiff line numberDiff line change
@@ -57,40 +57,3 @@ In today's digital landscape, verifying phone number ownership is critical to pr
5757
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.
5858

5959
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.
60-
61-
62-
## General Informations
63-
64-
> ⚙️ Problem Solved ?
65-
>
66-
> When you want to validate the user's digital identity.
67-
68-
69-
> ⚙️ How it works
70-
>
71-
> - Check if the registered phone number matches the number provided by the operator
72-
> - Excellent resource to reduce the number of steps when validating an application.
73-
74-
75-
> ⚙️ Parameters sent in the request
76-
>
77-
> - phoneNumber: “34612345678” (mobile phone number in the format - +551199999999)
78-
79-
80-
> ⚙️ Data received in the response
81-
>
82-
> - POST
83-
>
84-
> {
85-
> "devicePhoneNumberVerified": true
86-
> }
87-
>
88-
> - GET
89-
>
90-
> {
91-
> "devicePhoneNumber": "+34612345678"
92-
> }
93-
>
94-
>
95-
96-

v0/catalog/simswap/simswap.md

Lines changed: 0 additions & 31 deletions
Original file line numberDiff line numberDiff line change
@@ -72,34 +72,3 @@ This is where SIM swap fraud becomes dangerous. The "new" mobile phone can be us
7272
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.
7373

7474
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.
75-
76-
77-
## General Informations
78-
79-
> ⚙️ Problem Solved ?
80-
>
81-
> When was the last SIM change?
82-
83-
84-
> ⚙️ How it works
85-
>
86-
> Checks when the last SIM Card exchange was carried out on a mobile line or if this exchange was carried out within a specific period
87-
88-
> ⚙️ Parameters sent in the request
89-
>
90-
> - phoneNumber: Cell phone number that will be verified for exchange
91-
> - maxAge: period of hours to be checked for SIM change (minimum 1 hour / maximum 2400 hours / default 240 hours)
92-
93-
94-
> ⚙️ Data received in the response
95-
>
96-
> Returns swapped true if the SIM Card was changed and swapped false if it was not changed
97-
98-
99-
100-
101-
102-
103-
104-
105-

0 commit comments

Comments
 (0)