masstack

V0
V1
API Overview Resources Schemas

KycMatch

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

Name In Type Required Description
org_id path string true ‘none’
body body KycMatchKYC_MatchRequestBody true ‘none’

Request body - instance of KycMatchKYC_MatchRequestBody

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22

{
  "phoneNumber": "+123456789",
  "idDocument": "string",
  "name": "string",
  "givenName": "string",
  "familyName": "string",
  "nameKanaHankaku": "string",
  "nameKanaZenkaku": "string",
  "middleNames": "string",
  "familyNameAtBirth": "string",
  "address": "string",
  "streetName": "string",
  "streetNumber": "string",
  "postalCode": "string",
  "region": "string",
  "locality": "string",
  "country": "string",
  "houseNumberExtension": "string",
  "birthdate": "2019-08-24",
  "email": "user@example.com",
  "gender": "MALE"
}
Name Type Required Description
phoneNumber string false 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, prefixed with ‘+’.
idDocument string false Id number associated to the official identity document in the country. It may contain alphanumeric characters.
name string false 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 false First/given name or compound first/given name of the customer.
familyName string false Last name, family name, or surname of the customer.
nameKanaHankaku string false Complete name of the customer in Hankaku-Kana format (reading of name) for Japan.
nameKanaZenkaku string false Complete name of the customer in Zenkaku-Kana format (reading of name) for Japan.
middleNames string false Middle name/s of the customer.
familyNameAtBirth string false Last/family/sur- name at birth of the customer.
address string false 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 false Name of the street of the customer’s address. It should not include the type of the street.
streetNumber string false The street number of the customer’s address. Number identifying a specific property on the ‘streetName’.
postalCode string false Zip code or postal code
region string false Region/prefecture of the customer’s address
locality string false Locality of the customer’s address
country string false Country of the customer’s address. Format ISO 3166-1 alpha-2
houseNumberExtension string false Specific identifier of the house needed depending on the property type. For example, number of apartment in an apartment building.
birthdate string(date) false The birthdate of the customer, in RFC 3339 / ISO 8601 calendar date format (YYYY-MM-DD).
email string(email) false Email address of the customer in the RFC specified format (local-part@domain).
gender string false Gender of the customer (Male/Female/Other).
Property Values
gender one of [MALE, FEMALE, OTHER]

Request example

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27


curl -X POST https://opengateway.masstack.com/v0/orgs/{org_id}/kyc-match/match \
  -H "Content-Type: application/json" \
  -H "Accept: application/json" \
 --data-raw "{
  'phoneNumber': '+123456789',
  'idDocument': 'string',
  'name': 'string',
  'givenName': 'string',
  'familyName': 'string',
  'nameKanaHankaku': 'string',
  'nameKanaZenkaku': 'string',
  'middleNames': 'string',
  'familyNameAtBirth': 'string',
  'address': 'string',
  'streetName': 'string',
  'streetNumber': 'string',
  'postalCode': 'string',
  'region': 'string',
  'locality': 'string',
  'country': 'string',
  'houseNumberExtension': 'string',
  'birthdate': '2019-08-24',
  'email': 'user@example.com',
  'gender': 'MALE'
}"
Code Meaning Description Schema
200 OK OK KycMatchKYC_MatchResponse
400 Bad Request Bad Request Inline
401 Unauthorized Unauthorized Inline
403 Forbidden Forbidden Inline
404 Not Found Not found Inline
422 Unprocessable Entity Unprocessable Content Inline

Endpoints

Device Swap

    KycMatch