Skip to content

Commit df2c1ff

Browse files
diegotiddiegotid
committed
Fix readme validation errors
1 parent afcd0e8 commit df2c1ff

File tree

11 files changed

+34
-106
lines changed

11 files changed

+34
-106
lines changed

‎v0/catalog/devicelocation/devicelocation.md‎

Lines changed: 2 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -22,18 +22,8 @@ Furthermore, by verifying a user's location, businesses can offer more personali
2222
> Apply to join the [Developer Hub](https://opengateway.telefonica.com/en/developer-hub/join) and gain access to our Sandbox.
2323
2424
### Getting started on the Telefónica Open Gateway Sandbox
25-
[block:embed]
26-
{
27-
"html": "<iframe class=\"embedly-embed\" src=\"//cdn.embedly.com/widgets/media.html?src=https%3A%2F%2Fwww.youtube.com%2Fembed%2FsBMx9G4cKy4%3Ffeature%3Doembed&display_name=YouTube&url=https%3A%2F%2Fwww.youtube.com%2Fwatch%3Fv%3DsBMx9G4cKy4&image=https%3A%2F%2Fi.ytimg.com%2Fvi%2FsBMx9G4cKy4%2Fhqdefault.jpg&type=text%2Fhtml&schema=youtube\" width=\"854\" height=\"480\" scrolling=\"no\" title=\"YouTube embed\" frameborder=\"0\" allow=\"autoplay; fullscreen; encrypted-media; picture-in-picture;\" allowfullscreen=\"true\"></iframe>",
28-
"url": "https://www.youtube.com/watch?v=sBMx9G4cKy4",
29-
"title": "Greater Security in Identity Verifications with the Device Location Verification API",
30-
"favicon": "https://www.youtube.com/favicon.ico",
31-
"image": "https://i.ytimg.com/vi/sBMx9G4cKy4/hqdefault.jpg",
32-
"provider": "https://www.youtube.com/",
33-
"href": "https://www.youtube.com/watch?v=sBMx9G4cKy4",
34-
"typeOfEmbed": "youtube"
35-
}
36-
[/block]
25+
26+
[![Greater Security in Identity Verifications with the Device Location Verification API](https://i.ytimg.com/vi/sBMx9G4cKy4/hqdefault.jpg)](https://www.youtube.com/watch?v=sBMx9G4cKy4)
3727

3828
## Overview of the Device Location Verification CAMARA API
3929

‎v0/catalog/devicestatus/devicestatus.md‎

Lines changed: 2 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -18,18 +18,8 @@ This solution allows you to control resource management during international roa
1818
> Apply to join the [Developer Hub](https://opengateway.telefonica.com/en/developer-hub/join) and gain access to our Sandbox.
1919
2020
### Getting started on the Telefónica Open Gateway Sandbox
21-
[block:embed]
22-
{
23-
"html": "<iframe class=\"embedly-embed\" src=\"//cdn.embedly.com/widgets/media.html?src=https%3A%2F%2Fwww.youtube.com%2Fembed%2F58KzlZHICtY%3Ffeature%3Doembed&display_name=YouTube&url=https%3A%2F%2Fwww.youtube.com%2Fwatch%3Fv%3D58KzlZHICtY&image=https%3A%2F%2Fi.ytimg.com%2Fvi%2F58KzlZHICtY%2Fhqdefault.jpg&type=text%2Fhtml&schema=youtube\" width=\"854\" height=\"480\" scrolling=\"no\" title=\"YouTube embed\" frameborder=\"0\" allow=\"autoplay; fullscreen; encrypted-media; picture-in-picture;\" allowfullscreen=\"true\"></iframe>",
24-
"url": "https://www.youtube.com/watch?v=58KzlZHICtY",
25-
"title": "Reducing Digital Risk with the Device Status API",
26-
"favicon": "https://www.youtube.com/favicon.ico",
27-
"image": "https://i.ytimg.com/vi/58KzlZHICtY/hqdefault.jpg",
28-
"provider": "https://www.youtube.com/",
29-
"href": "https://www.youtube.com/watch?v=58KzlZHICtY",
30-
"typeOfEmbed": "youtube"
31-
}
32-
[/block]
21+
22+
[![Reducing Digital Risk with the Device Status API](https://i.ytimg.com/vi/58KzlZHICtY/hqdefault.jpg)](https://www.youtube.com/watch?v=58KzlZHICtY)
3323

3424
## Overview of the Device Status API
3525

‎v0/catalog/knowyourcustomer/knowyourcustomer.md‎

Lines changed: 2 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -17,18 +17,8 @@ This API provides a quick and efficient method to verify customer contact detail
1717
> Apply to join the [Developer Hub](https://opengateway.telefonica.com/en/developer-hub/join) and gain access to our Sandbox.
1818
1919
### Getting started on the Telefónica Open Gateway Sandbox
20-
[block:embed]
21-
{
22-
"html": "<iframe class=\"embedly-embed\" src=\"//cdn.embedly.com/widgets/media.html?src=https%3A%2F%2Fwww.youtube.com%2Fembed%2FMmQK8dg1Poo%3Ffeature%3Doembed&display_name=YouTube&url=https%3A%2F%2Fwww.youtube.com%2Fwatch%3Fv%3DMmQK8dg1Poo&image=https%3A%2F%2Fi.ytimg.com%2Fvi%2FMmQK8dg1Poo%2Fhqdefault.jpg&type=text%2Fhtml&schema=youtube\" width=\"854\" height=\"480\" scrolling=\"no\" title=\"YouTube embed\" frameborder=\"0\" allow=\"autoplay; fullscreen; encrypted-media; picture-in-picture;\" allowfullscreen=\"true\"></iframe>",
23-
"url": "https://www.youtube.com/watch?v=MmQK8dg1Poo",
24-
"title": "Stronger Identity Authentications with the Know Your Customer-Match API",
25-
"favicon": "https://www.youtube.com/favicon.ico",
26-
"image": "https://i.ytimg.com/vi/MmQK8dg1Poo/hqdefault.jpg",
27-
"provider": "https://www.youtube.com/",
28-
"href": "https://www.youtube.com/watch?v=MmQK8dg1Poo",
29-
"typeOfEmbed": "youtube"
30-
}
31-
[/block]
20+
21+
[![Stronger Identity Authentications with the Know Your Customer-Match API](https://i.ytimg.com/vi/MmQK8dg1Poo/hqdefault.jpg)](https://www.youtube.com/watch?v=MmQK8dg1Poo)
3222

3323
## Overview of the Know Your Customer API
3424

‎v0/catalog/knowyourcustomer/samplecode_knowyourcustomer.md‎

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -297,7 +297,6 @@ result = kycMatch_client.match({
297297
print(f"Address matches the user's? {result.addressMatch}")
298298
print(f"Id matches the user's? {result.idDocumentMatch}")
299299
print(f"Postal Code matches the user's? {result.postalCodeMatch}")
300-
301300
```
302301
```node Sample SDK for Node.js
303302
let result = kycMatchClient.match({
@@ -395,7 +394,6 @@ result = response.json()
395394
print(f"Address matches the user's? {result.addressMatch}")
396395
print(f"Id matches the user's? {result.idDocumentMatch}")
397396
print(f"Postal Code matches the user's? {result.postalCodeMatch}")
398-
399397
```
400398

401399
### Frontend flow

‎v0/catalog/numberverification/numberverification.md‎

Lines changed: 2 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -19,18 +19,8 @@ Built as part of the Open Gateway initiative, the Number Verification API provid
1919
> Apply to join the [Developer Hub](https://opengateway.telefonica.com/en/developer-hub/join) and gain access to our Sandbox.
2020
2121
### Getting started on the Telefónica Open Gateway Sandbox
22-
[block:embed]
23-
{
24-
"html": "<iframe class=\"embedly-embed\" src=\"//cdn.embedly.com/widgets/media.html?src=https%3A%2F%2Fwww.youtube.com%2Fembed%2FFUQGNlMwYSg%3Ffeature%3Doembed&display_name=YouTube&url=https%3A%2F%2Fwww.youtube.com%2Fwatch%3Fv%3DFUQGNlMwYSg&image=https%3A%2F%2Fi.ytimg.com%2Fvi%2FFUQGNlMwYSg%2Fhqdefault.jpg&type=text%2Fhtml&schema=youtube\" width=\"854\" height=\"480\" scrolling=\"no\" title=\"YouTube embed\" frameborder=\"0\" allow=\"autoplay; fullscreen; encrypted-media; picture-in-picture;\" allowfullscreen=\"true\"></iframe>",
25-
"url": "https://www.youtube.com/watch?v=FUQGNlMwYSg",
26-
"title": "Smoother Identity Validations with the Number Verification API",
27-
"favicon": "https://www.youtube.com/favicon.ico",
28-
"image": "https://i.ytimg.com/vi/FUQGNlMwYSg/hqdefault.jpg",
29-
"provider": "https://www.youtube.com/",
30-
"href": "https://www.youtube.com/watch?v=FUQGNlMwYSg",
31-
"typeOfEmbed": "youtube"
32-
}
33-
[/block]
22+
23+
[![Smoother Identity Validations with the Number Verification API](https://i.ytimg.com/vi/FUQGNlMwYSg/hqdefault.jpg)](https://www.youtube.com/watch?v=FUQGNlMwYSg)
3424

3525
## Overview of the Number Verification CAMARA API
3626

‎v0/catalog/qod/qod.md‎

Lines changed: 2 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -17,18 +17,8 @@ number of simultaneous users attending the sporting event in the same location.
1717
> Apply to join the [Developer Hub](https://opengateway.telefonica.com/en/developer-hub/join) and gain access to our Sandbox.
1818
1919
### Getting started on the Telefónica Open Gateway Sandbox
20-
[block:embed]
21-
{
22-
"html": "<iframe class=\"embedly-embed\" src=\"//cdn.embedly.com/widgets/media.html?src=https%3A%2F%2Fwww.youtube.com%2Fembed%2FovVWzyx34Do%3Ffeature%3Doembed&display_name=YouTube&url=https%3A%2F%2Fwww.youtube.com%2Fwatch%3Fv%3DovVWzyx34Do&image=https%3A%2F%2Fi.ytimg.com%2Fvi%2FovVWzyx34Do%2Fhqdefault.jpg&type=text%2Fhtml&schema=youtube\" width=\"854\" height=\"480\" scrolling=\"no\" title=\"YouTube embed\" frameborder=\"0\" allow=\"autoplay; fullscreen; encrypted-media; picture-in-picture;\" allowfullscreen=\"true\"></iframe>",
23-
"url": "https://www.youtube.com/watch?v=ovVWzyx34Do",
24-
"title": "Better Connectivity with QoD Mobile and QoD Wi-Fi APIs",
25-
"favicon": "https://www.youtube.com/favicon.ico",
26-
"image": "https://i.ytimg.com/vi/ovVWzyx34Do/hqdefault.jpg",
27-
"provider": "https://www.youtube.com/",
28-
"href": "https://www.youtube.com/watch?v=ovVWzyx34Do",
29-
"typeOfEmbed": "youtube"
30-
}
31-
[/block]
20+
21+
[![Better Connectivity with QoD Mobile and QoD Wi-Fi APIs](https://i.ytimg.com/vi/ovVWzyx34Do/hqdefault.jpg)](https://www.youtube.com/watch?v=ovVWzyx34Do)
3222

3323
## Overview of the QoD CAMARA API
3424

‎v0/catalog/simswap/samplecode_simswap.md‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -687,3 +687,4 @@ fetch("https://opengateway.aggregator.com/sim-swap/v0/retrieve-date", requestOpt
687687
console.log(`SIM was swapped: ${result.toLocaleString('en-GB', { timeZone: 'UTC' })}`)
688688
})
689689
```
690+
```

‎v0/catalog/simswap/simswap.md‎

Lines changed: 2 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -16,18 +16,8 @@ Additionally, the SIM Swap Unified API Access feature ensures access to network
1616
> Apply to join the [Developer Hub](https://opengateway.telefonica.com/en/developer-hub/join) and gain access to our Sandbox.
1717
1818
### Getting started on the Telefónica Open Gateway Sandbox
19-
[block:embed]
20-
{
21-
"html": "<iframe class=\"embedly-embed\" src=\"//cdn.embedly.com/widgets/media.html?src=https%3A%2F%2Fwww.youtube.com%2Fembed%2FPdo-HnTyQ_E%3Ffeature%3Doembed&display_name=YouTube&url=https%3A%2F%2Fwww.youtube.com%2Fwatch%3Fv%3DPdo-HnTyQ_E&image=https%3A%2F%2Fi.ytimg.com%2Fvi%2FPdo-HnTyQ_E%2Fhqdefault.jpg&type=text%2Fhtml&schema=youtube\" width=\"854\" height=\"480\" scrolling=\"no\" title=\"YouTube embed\" frameborder=\"0\" allow=\"autoplay; fullscreen; encrypted-media; picture-in-picture;\" allowfullscreen=\"true\"></iframe>",
22-
"url": "https://www.youtube.com/watch?v=Pdo-HnTyQ_E",
23-
"title": "Digital Fraud Prevention with the SIM Swap API",
24-
"favicon": "https://www.youtube.com/favicon.ico",
25-
"image": "https://i.ytimg.com/vi/Pdo-HnTyQ_E/hqdefault.jpg",
26-
"provider": "https://www.youtube.com/",
27-
"href": "https://www.youtube.com/watch?v=Pdo-HnTyQ_E",
28-
"typeOfEmbed": "youtube"
29-
}
30-
[/block]
19+
20+
[![Digital Fraud Prevention with the SIM Swap API](https://i.ytimg.com/vi/Pdo-HnTyQ_E/hqdefault.jpg)](https://www.youtube.com/watch?v=Pdo-HnTyQ_E)
3121

3222
## Overview of the SIM Swap CAMARA API
3323

‎v0/gettingstarted/sandbox/mocks.md‎

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@ When using the Sandbox in mock mode, the following rules apply:
3030

3131
| Input | Response Status | Response Body |
3232
|--------------|--------------------|------------------|
33-
| device > **networkAccessIdentifier** / **phoneNumber** / **ipv4Address** / **ipv6Address** ends in **9** | 409 | code: "CONFLICT" <br>message: "Another session is created for the same UE" |
33+
| device > **networkAccessIdentifier** / **phoneNumber** / **ipv4Address** / **ipv6Address** ends in **9** | 409 | code: "CONFLICT"<br/>message: "Another session is created for the same UE" |
3434
| **duration** Not in range **1...86400** seconds | 400 | message: error on duration not in range |
3535
| Valid input | 201 | Provided input adding: sessionId, startedAt, expiresAt, qosStatus, messages |
3636

@@ -48,7 +48,7 @@ Retrieve date
4848

4949
| Input | Response Status | Response Body |
5050
|--------------|--------------------|------------------|
51-
| **phoneNumber** ends in **9** | 409 | code: "CONFLICT" <br>message: "Another request is created for the same phone number" |
51+
| **phoneNumber** ends in **9** | 409 | code: "CONFLICT"<br/>message: "Another request is created for the same phone number" |
5252
| **phoneNumber** ends in **0...8** | 200 | latestSimChange: "2024-01-14T13:16:33.167Z" |
5353

5454
### Device Location Verification (v0.2)
@@ -57,9 +57,9 @@ Retrieve date
5757
|--------------|--------------------|------------------|
5858
| **device** > **networkAccessIdentifier** / **phoneNumber** / **ipv4Address** / **ipv6Address** ends in **4** | 404 | message: Device not found |
5959
| **maxAge** included and > 14400 | 404 | message: Device not found in the given maxAge |
60-
| **maxAge** not included <br>**center** > **latitude** round to integer ends in **0** | 200 | verificationResult: **"UNKNOWN"** |
61-
| **maxAge** included <br>**center** > **latitude** round to integer ends in **0** | 200 | verificationResult: **"UNKNOWN"** <br>lastLocationTime: (30 minutes + maxAge) to now |
62-
| **center** > **latitude** round to integer ends in **1** | 200 | verificationResult: **"PARTIAL"** <br>lastLocationTime: (30 minutes + maxAge) to now <br>matchRate: something between 50 if radius=2 and 99 if radius=200 |
60+
| **maxAge** not included<br/>**center** > **latitude** round to integer ends in **0** | 200 | verificationResult: **"UNKNOWN"** |
61+
| **maxAge** included<br/>**center** > **latitude** round to integer ends in **0** | 200 | verificationResult: **"UNKNOWN"**<br/>lastLocationTime: (30 minutes + maxAge) to now |
62+
| **center** > **latitude** round to integer ends in **1** | 200 | verificationResult: **"PARTIAL"**<br/>lastLocationTime: (30 minutes + maxAge) to now<br/>matchRate: something between 50 if radius=2 and 99 if radius=200 |
6363
| **center** > **latitude** round to integer is **even** | 200 | verificationResult: **"TRUE"** |
6464
| **center** > **latitude** round to integer is **odd** | 200 | verificationResult: **"FALSE"** |
6565

@@ -76,7 +76,7 @@ Retrieve date
7676
| Input | Response Status | Response Body |
7777
|--------------|--------------------|------------------|
7878
| Any invalid input | 400 | message: Details on the invalid input value |
79-
| Valid input | 200 | For every input value, response includes... <br>match: boolean <br>matchScore: 0...100 (only for some keys) <br>Those will be the result of matching the request data with a [mock user persona](https://github.com/camaraproject/KnowYourCustomer/blob/a2575b08550640999614a43dd2146ceab6b6e469/code/API_definitions/kyc-match.yaml#L105) |
79+
| Valid input | 200 | For every input value, response includes...<br/>match: boolean<br/>matchScore: 0...100 (only for some keys)<br/>Those will be the result of matching the request data with a [mock user persona](https://github.com/camaraproject/KnowYourCustomer/blob/a2575b08550640999614a43dd2146ceab6b6e469/code/API_definitions/kyc-match.yaml#L105) |
8080

8181
### KYC Age Verification (v0.1)
8282

@@ -105,4 +105,4 @@ It will determine which mock user persona is used to verify the line holding ten
105105
| Input | Response Status | Response Body |
106106
|--------------|--------------------|------------------|
107107
| **phoneNumber** is **even** | 200 | callInProgress: **false** |
108-
| **phoneNumber** is **odd** | 200 | callInProgress: **true** <br>callStartTime: "2023-07-03T12:27:08.312Z" |
108+
| **phoneNumber** is **odd** | 200 | callInProgress: **true**<br/>callStartTime: "2023-07-03T12:27:08.312Z" |

‎v0/gettingstarted/sandbox/postmaninteraction.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -56,7 +56,7 @@ To use an environment in Postmam:
5656

5757
1. Select the desired environment by clicking on the drop-down menu in the top right corner of the interface.
5858
2. The variables defined in the environment will be available for use in collection requests. Collection requests already use the following environment variables in the format
59-
{{variable_name}}. You simply need to edit the environment, after importing it, and modify
59+
`{{variable_name}}`. You simply need to edit the environment, after importing it, and modify
6060
them according to your own test configuration:
6161
- **‘api-gateway-url** - Fixed. Should not be changed if you want to run your tests on the Sandbox. Its value is https://sandbox.opengateway.telefonica.com/apigateway
6262
- **‘application-client-id’** - Value that identifies each of the apps you have registered in the Sandbox. You can check it in the ‘My apps’ section.

0 commit comments

Comments
 (0)