Know Your Customer Match (0.1.1)

Download OpenAPI specification:Download

E-mail: contact@spryfoxnetworks.com License: Apache 2.0 Terms of Service

This API provides the customer with the ability to compare the information it (Service Provider, SP) has for a particular mobile phone user with that on file (and verified) by the mobile phone user's Operator in their own KYC records, in order for the SP to confirm the accuracy of the information and provide a specific service to the mobile phone user.

Relevant Definitions and concepts

KYC: stands for Know Your Customer and it is the process of a business verifying the identity of their clients and assessing their suitability, along with the potential risks of illegal intentions towards the business relationship.

API Functionality

This API allows API clients to verify the matching of a number of attributes related to a customer identity against the account data bound to their phone number. The API is intended to be used in the following scenarios, for example:

To verify the user personal data during the digital registration of an account to a 3rd party service.
To prevent fraud, wrong or imprecise information, and/or facilitate the onboarding of a mobile phone user to a 3rd party service.

The following figure is the generic high-level flows of this API.

Note:

Before calling this API, 3rd parties / enterprise customers who want to use this API should make contact with API provider/ MNO for use of this API. As that will depend on each API provider / MNO's business process as well as GSMA Open Gateway standard process, it is out of scope of this API definition.
When calling this API, at the beginning, there should be required processes for Authentication / Authorisation / End User Consent capturing. As those processes are defined as CAMARA commonality standards, they are out of scope of this API definition, however, use of the OpenID Connect (OIDC) is stated as security scheme.

Resources and Operations overview

The API provides the following endpoint:

An endpoint to verify the matching of a number of attributes related to a mobile phone user identity against the account data bound to their phone number.

Match

Operations to match a customer identity against the account data bound to their phone number.

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

Authorizations:

openId

header Parameters

x-correlator

string

Correlation id for the different services

Request Body schema: application/json
required

phoneNumber	string A public identifier addressing a telephone subscription. In mobile networks it corresponds to the MSISDN (Mobile Station International Subscriber Directory Number). In order to be globally unique it has to be formatted in international format, according to E.164 standard, optionally prefixed with '+'.
idDocument	string Id number associated to the official identity document in the country. It may contain alphanumeric characters.
name	string 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.
givenName	string First/given name or compound first/given name of the customer.
familyName	string Last name, family name, or surname of the customer.
nameKanaHankaku	string Complete name of the customer in Hankaku-Kana format (reading of name) for Japan.
nameKanaZenkaku	string Complete name of the customer in Zenkaku-Kana format (reading of name) for Japan.
middleNames	string Middle name/s of the customer.
familyNameAtBirth	string Last/family/sur- name at birth of the customer.
address	string Complete address of the customer. For some countries, it is built following the usual concatenation of parameters in a country, but for other countries, this is not the case. For some countries, it can use streetName, streetNumber and/or houseNumberExtension. For example, in ESP, streetName+streetNumber; in NLD, it can be streetName+streetNumber or streetName+streetNumber+houseNumberExtension.
streetName	string Name of the street of the customer's address. It should not include the type of the street.
streetNumber	string The street number of the customer's address. Number identifying a specific property on the 'streetName'.
postalCode	string Zip code or postal code
region	string Region/prefecture of the customer's address
locality	string Locality of the customer's address
country	string Country of the customer's address. Format ISO 3166-1 alpha-2
houseNumberExtension	string Specific identifier of the house needed depending on the property type. For example, number of apartment in an apartment building.
birthdate	string The birthdate of the customer, in ISO 8601 calendar date format (YYYY-MM-DD).
email	string Email address of the customer in the RFC specified format (local-part@domain).
gender	string Enum: "MALE" "FEMALE" "OTHER" Gender of the customer (Male/Female/Other).

Responses

Request samples

Payload

Content type

application/json

{"phoneNumber": "+34629255833",
"idDocument": "66666666q",
"name": "Federica Sanchez Arjona",
"giventName": "Federica",
"familyName": "Sanchez Arjona",
"nameKanaHankaku": "federica",
"nameKanaZenkaku": "Ｆｅｄｅｒｉｃａ",
"middleNames": "Sanchez",
"familyNameAtBirth": "YYYY",
"address": "Tokyo-to Chiyoda-ku Iidabashi 3-10-10",
"streetName": "Nicolas Salmeron",
"streetNumber": 4,
"postalCode": 1028460,
"region": "Tokyo",
"locality": "ZZZZ",
"country": "JP",
"houseNumberExtension": "VVVV",
"birthdate": "1978-08-22",
"email": "abc@example.com",
"gender": "male"
}

Response samples