Skip to content

Add bankaccountnumber as an attribute to KYC Match #73

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
GillesInnov35 merged 2 commits into from
Jun 24, 2026
Merged

Add bankaccountnumber as an attribute to KYC Match #73

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
8cfc0e8
Update kyc-match.yaml
ToshiWakayama-KDDI Jun 8, 2026
e5ad70a
Update kyc-match.yaml for a correction
ToshiWakayama-KDDI Jun 8, 2026
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
15 changes: 15 additions & 0 deletions code/API_definitions/kyc-match.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -92,7 +92,7 @@
- **true**: the attribute provided matches with the one in the Operator systems, which is equal to a `match_score` of 100.
- **false**: the attribute provided does not match with the one in the Operator systems.
- **not_available**: the attribute is not available to validate.
operationId: KYC_Match

Check notice on line 95 in code/API_definitions/kyc-match.yaml

View workflow job for this annotation

GitHub Actions / validation / Validate

operationId must be camelCase 

[S-007] Operation Id must be in Camel case "must be camel case"

security:
- openId:
Expand All @@ -116,6 +116,7 @@
idDocument: 66666666q
idDocumentType: passport
idDocumentExpiryDate: '2027-07-12'
bankAccountNumber: IBAN:NL59ABNA0123456789
name: Federica Sanchez Arjona
givenName: Federica
familyName: Sanchez Arjona
Expand All @@ -142,6 +143,7 @@
idDocument: 66666666q
idDocumentType: passport
idDocumentExpiryDate: '2027-07-12'
bankAccountNumber: IBAN:NL59ABNA0123456789
name: Federica Sanchez Arjona
givenName: Federica
familyName: Sanchez Arjona
Expand Down Expand Up @@ -182,6 +184,7 @@
idDocumentMatch: 'true'
idDocumentTypeMatch: 'true'
idDocumentExpiryDateMatch: 'true'
bankAccountNumberMatch: 'true'
nameMatch: 'true'
givenNameMatch: 'not_available'
familyNameMatch: 'not_available'
Expand Down Expand Up @@ -224,7 +227,7 @@

components:
securitySchemes:
openId:

Check warning on line 230 in code/API_definitions/kyc-match.yaml

View workflow job for this annotation

GitHub Actions / validation / Validate

Schema property must have a description 

[S-011] Property description is missing or empty%3A "openId.description" property must be truthy
type: openIdConnect
openIdConnectUrl: https://example.com/.well-known/openid-configuration

Expand All @@ -247,12 +250,12 @@

schemas:

XCorrelator:

Check warning on line 253 in code/API_definitions/kyc-match.yaml

View workflow job for this annotation

GitHub Actions / validation / Validate

Schema property must have a description 

[S-011] Property description is missing or empty%3A "XCorrelator.description" property must be truthy
type: string
pattern: ^[a-zA-Z0-9-_:;.\/<>{}]{0,256}$
example: "b4333c46-49c0-4f62-80d7-f0ef930f1c46"

KYC_MatchRequestBody:

Check warning on line 258 in code/API_definitions/kyc-match.yaml

View workflow job for this annotation

GitHub Actions / validation / Validate

Schema name must be PascalCase 

[S-015] KYC_MatchRequestBody should be PascalCase (UpperCamelCase)
type: object
description: Payload to validate the customer data.

Expand All @@ -277,6 +280,12 @@
format: date
description: Expiration date of the identity document (ISO 8601).

bankAccountNumber:
type: string
maxLength: 50
pattern: '^[A-Z]+:[A-Za-z0-9]+$'
description: The bank account number maintained by the API Provider (Telco operator) to collect monthly subscription payments from the contract owner. The string is formatted as `PREFIX:VALUE`. The uppercase prefix before the colon (':') indicates the type of account number (e.g., IBAN, SWIFT), and the alphanumeric string after the colon represents the actual bank account number.

name:
type: string
description: Complete name of the customer, usually composed of first/given name and last/family/sur- name in a country. Depending on the country, the order of first/give name and last/family/sur- name varies, and middle name could be included. It can use givenName, middleNames, familyName and/or familyNameAtBirth. For example, in ESP, name+familyName; in NLD, it can be name+middleNames+familyName or name+middleNames+familyNameAtBirth, etc.
Expand Down Expand Up @@ -386,21 +395,27 @@
minimum: 0
maximum: 99

KYC_MatchResponse:

Check warning on line 398 in code/API_definitions/kyc-match.yaml

View workflow job for this annotation

GitHub Actions / validation / Validate

Schema name must be PascalCase 

[S-015] KYC_MatchResponse should be PascalCase (UpperCamelCase)

Check warning on line 398 in code/API_definitions/kyc-match.yaml

View workflow job for this annotation

GitHub Actions / validation / Validate

Schema property must have a description 

[S-011] Property description is missing or empty%3A "KYC_MatchResponse.description" property must be truthy
type: object
properties:
idDocumentMatch:

Check warning on line 401 in code/API_definitions/kyc-match.yaml

View workflow job for this annotation

GitHub Actions / validation / Validate

Schema property must have a description 

[S-011] Property description is missing or empty%3A "idDocumentMatch.description" property must be truthy
allOf:
- $ref: '#/components/schemas/MatchResult'
- description: Indicates whether Id number associated to the ID document of the customer matches with the one on the Operator's system.
idDocumentTypeMatch:

Check warning on line 405 in code/API_definitions/kyc-match.yaml

View workflow job for this annotation

GitHub Actions / validation / Validate

Schema property must have a description 

[S-011] Property description is missing or empty%3A "idDocumentTypeMatch.description" property must be truthy
allOf:
- $ref: '#/components/schemas/MatchResult'
- description: Indicates whether document type associated to the ID document of the customer matches with the one on the Operator's system.
idDocumentExpiryDateMatch:

Check warning on line 409 in code/API_definitions/kyc-match.yaml

View workflow job for this annotation

GitHub Actions / validation / Validate

Schema property must have a description 

[S-011] Property description is missing or empty%3A "idDocumentExpiryDateMatch.description" property must be truthy
allOf:
- $ref: '#/components/schemas/MatchResult'
- description: Indicates whether document expiration date associated to the ID document of the customer matches with the one on the Operator's system.

bankAccountNumberMatch:

Check warning on line 414 in code/API_definitions/kyc-match.yaml

View workflow job for this annotation

GitHub Actions / validation / Validate

Schema property must have a description 

[S-011] Property description is missing or empty%3A "bankAccountNumberMatch.description" property must be truthy
allOf:
- $ref: '#/components/schemas/MatchResult'
- description: Indicates whether the provided bankAccountNumber matches the records in the API Provider (Telco operator)'s system.

nameMatch:
allOf:
- $ref: '#/components/schemas/MatchResult'
Expand Down
Loading