API Reference

Copy Markdown

Open in Claude

Open in ChatGPT

Open in Cursor

---

Copy Markdown

View as Markdown

Knowyourcustomermatch

Know Your Customer Match

Matching a customer identity by checking a set of attributes related against the account data bound to their phone number.

client.knowyourcustomermatch.match(KnowyourcustomermatchMatchParams { address, birthdate, cityOfBirth, 23 more } params, RequestOptionsoptions?): KnowyourcustomermatchMatchResponse { addressMatch, addressMatchScore, birthdateMatch, 35 more }

POST/knowyourcustomermatch/match

ModelsExpand Collapse

MatchResult = "true" | "false" | "not_available"

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.

One of the following:

"true"

"false"

"not_available"

KnowyourcustomermatchMatchResponse { addressMatch, addressMatchScore, birthdateMatch, 35 more }

addressMatch?: MatchResult

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.

One of the following:

"true"

"false"

"not_available"

addressMatchScore?: number

Indicates the similarity score assigned to the input value when it does not exactly match the value stored in the operator’s system. This property shall only be returned when the value of the corresponding match field is false. A perfect match with a score of 100 is indicated by match being ‘true’ and no matchScore is returned in this case.

minimum0

maximum99

birthdateMatch?: MatchResult

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.

One of the following:

"true"

"false"

"not_available"

cityOfBirthMatch?: MatchResult

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.

One of the following:

"true"

"false"

"not_available"

cityOfBirthMatchScore?: number

Indicates the similarity score assigned to the input value when it does not exactly match the value stored in the operator’s system. This property shall only be returned when the value of the corresponding match field is false. A perfect match with a score of 100 is indicated by match being ‘true’ and no matchScore is returned in this case.

minimum0

maximum99

countryMatch?: MatchResult

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.

One of the following:

"true"

"false"

"not_available"

countryOfBirthMatch?: MatchResult

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.

One of the following:

"true"

"false"

"not_available"

emailMatch?: MatchResult

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.

One of the following:

"true"

"false"

"not_available"

emailMatchScore?: number

Indicates the similarity score assigned to the input value when it does not exactly match the value stored in the operator’s system. This property shall only be returned when the value of the corresponding match field is false. A perfect match with a score of 100 is indicated by match being ‘true’ and no matchScore is returned in this case.

minimum0

maximum99

familyNameAtBirthMatch?: MatchResult

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.

One of the following:

"true"

"false"

"not_available"

familyNameAtBirthMatchScore?: number

Indicates the similarity score assigned to the input value when it does not exactly match the value stored in the operator’s system. This property shall only be returned when the value of the corresponding match field is false. A perfect match with a score of 100 is indicated by match being ‘true’ and no matchScore is returned in this case.

minimum0

maximum99

familyNameMatch?: MatchResult

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.

One of the following:

"true"

"false"

"not_available"

familyNameMatchScore?: number

Indicates the similarity score assigned to the input value when it does not exactly match the value stored in the operator’s system. This property shall only be returned when the value of the corresponding match field is false. A perfect match with a score of 100 is indicated by match being ‘true’ and no matchScore is returned in this case.

minimum0

maximum99

genderMatch?: MatchResult

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.

One of the following:

"true"

"false"

"not_available"

givenNameMatch?: MatchResult

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.

One of the following:

"true"

"false"

"not_available"

givenNameMatchScore?: number

Indicates the similarity score assigned to the input value when it does not exactly match the value stored in the operator’s system. This property shall only be returned when the value of the corresponding match field is false. A perfect match with a score of 100 is indicated by match being ‘true’ and no matchScore is returned in this case.

minimum0

maximum99

houseNumberExtensionMatch?: MatchResult

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.

One of the following:

"true"

"false"

"not_available"

idDocumentExpiryDateMatch?: MatchResult

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.

One of the following:

"true"

"false"

"not_available"

idDocumentMatch?: MatchResult

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.

One of the following:

"true"

"false"

"not_available"

idDocumentTypeMatch?: MatchResult

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.

One of the following:

"true"

"false"

"not_available"

localityMatch?: MatchResult

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.

One of the following:

"true"

"false"

"not_available"

localityMatchScore?: number

Indicates the similarity score assigned to the input value when it does not exactly match the value stored in the operator’s system. This property shall only be returned when the value of the corresponding match field is false. A perfect match with a score of 100 is indicated by match being ‘true’ and no matchScore is returned in this case.

minimum0

maximum99

middleNamesMatch?: MatchResult

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.

One of the following:

"true"

"false"

"not_available"

middleNamesMatchScore?: number

Indicates the similarity score assigned to the input value when it does not exactly match the value stored in the operator’s system. This property shall only be returned when the value of the corresponding match field is false. A perfect match with a score of 100 is indicated by match being ‘true’ and no matchScore is returned in this case.

minimum0

maximum99

nameKanaHankakuMatch?: MatchResult

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.

One of the following:

"true"

"false"

"not_available"

nameKanaHankakuMatchScore?: number

Indicates the similarity score assigned to the input value when it does not exactly match the value stored in the operator’s system. This property shall only be returned when the value of the corresponding match field is false. A perfect match with a score of 100 is indicated by match being ‘true’ and no matchScore is returned in this case.

minimum0

maximum99

nameKanaZenkakuMatch?: MatchResult

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.

One of the following:

"true"

"false"

"not_available"

nameKanaZenkakuMatchScore?: number

Indicates the similarity score assigned to the input value when it does not exactly match the value stored in the operator’s system. This property shall only be returned when the value of the corresponding match field is false. A perfect match with a score of 100 is indicated by match being ‘true’ and no matchScore is returned in this case.

minimum0

maximum99

nameMatch?: MatchResult

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.

One of the following:

"true"

"false"

"not_available"

nameMatchScore?: number

Indicates the similarity score assigned to the input value when it does not exactly match the value stored in the operator’s system. This property shall only be returned when the value of the corresponding match field is false. A perfect match with a score of 100 is indicated by match being ‘true’ and no matchScore is returned in this case.

minimum0

maximum99

nationalityMatch?: MatchResult

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.

One of the following:

"true"

"false"

"not_available"

postalCodeMatch?: MatchResult

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.

One of the following:

"true"

"false"

"not_available"

regionMatch?: MatchResult

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.

One of the following:

"true"

"false"

"not_available"

regionMatchScore?: number

Indicates the similarity score assigned to the input value when it does not exactly match the value stored in the operator’s system. This property shall only be returned when the value of the corresponding match field is false. A perfect match with a score of 100 is indicated by match being ‘true’ and no matchScore is returned in this case.

minimum0

maximum99

streetNameMatch?: MatchResult

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.

One of the following:

"true"

"false"

"not_available"

streetNameMatchScore?: number

Indicates the similarity score assigned to the input value when it does not exactly match the value stored in the operator’s system. This property shall only be returned when the value of the corresponding match field is false. A perfect match with a score of 100 is indicated by match being ‘true’ and no matchScore is returned in this case.

minimum0

maximum99

streetNumberMatch?: MatchResult

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.

One of the following:

"true"

"false"

"not_available"

streetNumberMatchScore?: number

Indicates the similarity score assigned to the input value when it does not exactly match the value stored in the operator’s system. This property shall only be returned when the value of the corresponding match field is false. A perfect match with a score of 100 is indicated by match being ‘true’ and no matchScore is returned in this case.

minimum0

maximum99