Skip to content

Added openapi metadata for simswap and kyc match #44

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
May 23, 2025
Merged

Added openapi metadata for simswap and kyc match #44

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
8d03418
added openapi metadata for simswap and kyc match
vickybesra May 5, 2025
ea97ffa
Added new APIs metadata with their latest yaml artifacts
vickybesra May 12, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
67 changes: 67 additions & 0 deletions telco/camaraproject.org/KnowYourCustomer/kyc-match-0.3.0-openapi-metadata.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,67 @@
apiVersion: mocks.microcks.io/v1alpha1
kind: APIExamples
metadata:
name: Know Your Customer Match
version: 0.3.0
operations:
POST /match:
Successful match with name and birthdate:
request:
headers:
accept: application/json
body: |
{
"phoneNumber": "+12016219813",
"name": "John Doe",
"birthdate": "1985-02-08"
}
response:
headers:
content-type: application/json
status: 200
mediaType: application/json
body: |
{
"nameMatch": "true",
"birthdateMatch": "true"
}
Partial match with email and mismatch on gender:
request:
headers:
accept: application/json
body: |
{
"phoneNumber": "+447405580375",
"email": "[email protected]",
"gender": "MALE"
}
response:
headers:
content-type: application/json
status: 200
mediaType: application/json
body: |
{
"emailMatch": "true",
"genderMatch": "false"
}
Failed match due to ID document mismatch:
request:
headers:
accept: application/json
body: |
{
"phoneNumber": "+937018460616",
"idDocument": "AB1234567"
}
response:
headers:
content-type: application/json
status: 403
mediaType: application/json
body: |
{
"status": 403,
"code": "KNOW_YOUR_CUSTOMER.ID_DOCUMENT_MISMATCH",
"message": "The provided ID document does not match our records."
}
182 changes: 182 additions & 0 deletions ...ect.org/device-reachability-status/device-reachability-status-1.0.0-openapi-metadata.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,182 @@
apiVersion: mocks.microcks.io/v1alpha1
kind: APIExamples
metadata:
name: Device Reachability Status
version: 1.0.0
operations:
POST /retrieve:
Single IPv4 address:
request:
headers:
accept: application/json
body: |-
{
"device" : {
"ipv4Address" : {
"publicAddress" : "192.168.1.1",
"privateAddress" : "192.168.1.1"
},
"phoneNumber" : "+123456789"
}
}
response:
status: 200
Unique IPv6 address:
request:
headers:
accept: application/json
body: |-
{
"device" : {
"ipv6Address" : "2001:0db8:85a3:0000:0000:8a2e:0370:7334"
}
}
response:
status: 200
Multiple identifiers:
request:
headers:
accept: application/json
body: |-
{
"device" : {
"ipv6Address" : "2001:0db8:85a3:0000:0000:8a2e:0370:7334",
"phoneNumber" : "+987654321"
}
}
response:
status: 200
Retrieve device reachability status - Example 1:
request:
headers:
accept: application/json
body: |-
{
"device" : {
"phoneNumber" : "+123456789"
}
}
response:
headers:
content-type: application/json
status: 200
mediaType: application/json
body: |-
{
"lastStatusTime" : "2023-01-30T16:59:58Z",
"reachable" : true,
"connectivity" : [ "DATA" ]
}
Retrieve device reachability status - Example 2:
request:
headers:
accept: application/json
body: |-
{
"device" : {
"ipv4Address" : {
"publicAddress" : "192.0.2.1",
"privateAddress" : "192.168.1.1",
"publicPort" : 8080
}
}
}
response:
headers:
content-type: application/json
status: 200
mediaType: application/json
body: |-
{
"lastStatusTime" : "2023-01-30T16:59:58Z",
"reachable" : false,
"connectivity" : [ "SMS" ]
}
Retrieve device reachability status - Example 3:
request:
headers:
accept: application/json
body: |-
{
"device" : {
"networkAccessIdentifier" : "ABCD1234@operator"
}
}
response:
headers:
content-type: application/json
status: 200
mediaType: application/json
body: |-
{
"lastStatusTime" : "2023-01-30T16:59:58Z",
"reachable" : true,
"connectivity" : [ "DATA", "SMS" ]
}
example 1:
request:
headers:
accept: application/json
body: |-
{
"device" : {
"phoneNumber" : "+123456789"
}
}
response:
headers:
content-type: application/json
status: 200
mediaType: application/json
body: |-
{
"lastStatusTime" : "2022-01-01T12:00:00Z",
"reachable" : true,
"connectivity" : [ "DATA" ]
}
example 2:
request:
headers:
accept: application/json
body: |-
{
"device" : {
"ipv4Address" : {
"publicAddress" : "192.168.1.10",
"privateAddress" : "10.0.0.1",
"publicPort" : 8080
}
}
}
response:
headers:
content-type: application/json
status: 200
mediaType: application/json
body: |-
{
"lastStatusTime" : "2022-01-02T08:30:00Z",
"reachable" : false,
"connectivity" : [ "SMS" ]
}
example 3:
request:
headers:
accept: application/json
body: |-
{
"device" : {
"ipv6Address" : "2001:0db8:85a3:0000:0000:8a2e:0370:7334"
}
}
response:
headers:
content-type: application/json
status: 200
mediaType: application/json
body: |-
{
"lastStatusTime" : "2022-01-03T16:45:00Z",
"reachable" : true,
"connectivity" : [ "DATA" ]
}
Loading