API Overview Resources Schemas

Schemas

DeviceSwapDeviceSwapInfo

1
2
3


{
  "latestDeviceChange": "2023-07-03T14:27:08.312+02:00"
}

Name	Type	Required	Description
latestDeviceChange	string(date-time)¦null	true	Timestamp of latest device swap performed. It must follow RFC 3339 and must have time zone. Recommended format is yyyy-MM-dd’T’HH:mm:ss.SSSZ (i.e. which allows 2023-07-03T14:27:08.312+02:00 or 2023-07-03T12:27:08.312Z)

DeviceSwapCreateDeviceSwapDate

1
2
3


{
  "phoneNumber": "+34666111333"
}

Name	Type	Required	Description
phoneNumber	DeviceSwapPhoneNumber	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 ‘+’.

DeviceSwapCreateCheckDeviceSwap

1
2
3
4


{
  "phoneNumber": "+34666111333",
  "maxAge": 240
}

Name	Type	Required	Description
phoneNumber	DeviceSwapPhoneNumber	true	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 ‘+’.
maxAge	integer(int32)	true	Period in hours to be checked for device swap.

DeviceSwapPhoneNumber

1

"+34666111333"

Name	Type	Required	Description
anonymous	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 ‘+’.

DeviceSwapCheckDeviceSwapInfo

1
2
3


{
  "swapped": true
}

Name	Type	Required	Description
swapped	boolean	true	Indicates whether the device has been swapped during the period within the provided age.

DeviceSwapErrorInfo

1
2
3
4
5


{
  "status": 0,
  "code": "string",
  "message": "string"
}

Name	Type	Required	Description
status	integer	true	HTTP response status code
code	string	true	Code given to this error
message	string	true	Detailed error description

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]

KycMatchMatchResult

1

"true"

Name	Type	Required	Description
anonymous	string	false	none

Property	Values
anonymous	one of [true, false, not_available]

KycMatchMatchScoreResult

1

100

Name	Type	Required	Description
anonymous	integer	false	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`.

KycMatchKYC_MatchResponse

 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
28
29
30
31
32
33
34


{
  "idDocumentMatch": "true",
  "nameMatch": "true",
  "nameMatchScore": 100,
  "givenNameMatch": "true",
  "givenNameMatchScore": 100,
  "familyNameMatch": "true",
  "familyNameMatchScore": 100,
  "nameKanaHankakuMatch": "true",
  "nameKanaHankakuMatchScore": 100,
  "nameKanaZenkakuMatch": "true",
  "nameKanaZenkakuMatchScore": 100,
  "middleNamesMatch": "true",
  "middleNamesMatchScore": 100,
  "familyNameAtBirthMatch": "true",
  "familyNameAtBirthMatchScore": 100,
  "addressMatch": "true",
  "addressMatchScore": 100,
  "streetNameMatch": "true",
  "streetNameMatchScore": 100,
  "streetNumberMatch": "true",
  "streetNumberMatchScore": 100,
  "postalCodeMatch": "true",
  "regionMatch": "true",
  "regionMatchScore": 100,
  "localityMatch": "true",
  "localityMatchScore": 100,
  "countryMatch": "true",
  "houseNumberExtensionMatch": "true",
  "birthdateMatch": "true",
  "emailMatch": "true",
  "emailMatchScore": 100,
  "genderMatch": "true"
}

Name	Type	Required	Description
idDocumentMatch	any	false	none

Name	Type	Required	Description
» anonymous	KycMatchMatchResult	false	none

Name	Type	Required	Description
» anonymous	any	false	Indicates whether Id number associated to the ID document of the customer matches with the one on the Operator’s system.

Name	Type	Required	Description
nameMatch	any	false	none

Name	Type	Required	Description
» anonymous	KycMatchMatchResult	false	none

Name	Type	Required	Description
» anonymous	any	false	Indicates whether the complete name of the customer matches with the one on the Operator’s system.

Name	Type	Required	Description
nameMatchScore	KycMatchMatchScoreResult	false	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`.
givenNameMatch	any	false	none

Name	Type	Required	Description
» anonymous	KycMatchMatchResult	false	none

Name	Type	Required	Description
» anonymous	any	false	Indicates whether First name/given name of the customer matches with the one on the Operator’s system.

Name	Type	Required	Description
givenNameMatchScore	KycMatchMatchScoreResult	false	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`.
familyNameMatch	any	false	none

Name	Type	Required	Description
» anonymous	KycMatchMatchResult	false	none

Name	Type	Required	Description
» anonymous	any	false	Indicates whether last name/ family name/ surname of the customer matches with the one on the Operator’s system.

Name	Type	Required	Description
familyNameMatchScore	KycMatchMatchScoreResult	false	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`.
nameKanaHankakuMatch	any	false	none

Name	Type	Required	Description
» anonymous	KycMatchMatchResult	false	none

Name	Type	Required	Description
» anonymous	any	false	Indicates whether complete name of the customer in Hankaku-Kana format (reading of name) for Japan matches with the one on the Operator’s system.

Name	Type	Required	Description
nameKanaHankakuMatchScore	KycMatchMatchScoreResult	false	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`.
nameKanaZenkakuMatch	any	false	none

Name	Type	Required	Description
» anonymous	KycMatchMatchResult	false	none

Name	Type	Required	Description
» anonymous	any	false	Indicates whether complete name of the customer in Zenkaku-Kana format (reading of name) for Japan matches with the one on the Operator’s system.

Name	Type	Required	Description
nameKanaZenkakuMatchScore	KycMatchMatchScoreResult	false	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`.
middleNamesMatch	any	false	none

Name	Type	Required	Description
» anonymous	KycMatchMatchResult	false	none

Name	Type	Required	Description
» anonymous	any	false	Indicates whether the middle names of the customer matches with the one on the Operator’s system.

Name	Type	Required	Description
middleNamesMatchScore	KycMatchMatchScoreResult	false	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`.
familyNameAtBirthMatch	any	false	none

Name	Type	Required	Description
» anonymous	KycMatchMatchResult	false	none

Name	Type	Required	Description
» anonymous	any	false	Indicates whether the Family Name At Birth of the customer matches with the one on the Operator’s system.

Name	Type	Required	Description
familyNameAtBirthMatchScore	KycMatchMatchScoreResult	false	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`.
addressMatch	any	false	none

Name	Type	Required	Description
» anonymous	KycMatchMatchResult	false	none

Name	Type	Required	Description
» anonymous	any	false	Indicates whether complete address of the customer matches with the one on the Operator’s system.

Name	Type	Required	Description
addressMatchScore	KycMatchMatchScoreResult	false	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`.
streetNameMatch	any	false	none

Name	Type	Required	Description
» anonymous	KycMatchMatchResult	false	none

Name	Type	Required	Description
» anonymous	any	false	Indicates whether the street name of the customer matches with the one on the Operator’s system.

Name	Type	Required	Description
streetNameMatchScore	KycMatchMatchScoreResult	false	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`.
streetNumberMatch	any	false	none

Name	Type	Required	Description
» anonymous	KycMatchMatchResult	false	none

Name	Type	Required	Description
» anonymous	any	false	Indicates whether the street number of the customer matches with the one on the Operator’s system.

Name	Type	Required	Description
streetNumberMatchScore	KycMatchMatchScoreResult	false	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`.
postalCodeMatch	any	false	none

Name	Type	Required	Description
» anonymous	KycMatchMatchResult	false	none

Name	Type	Required	Description
» anonymous	any	false	Indicates whether the postal code / zip code of the customer matches with the one on the Operator’s system.

Name	Type	Required	Description
regionMatch	any	false	none

Name	Type	Required	Description
» anonymous	KycMatchMatchResult	false	none

Name	Type	Required	Description
» anonymous	any	false	Indicates whether the region of the customer’s address matches with the one on the Operator’s system.

Name	Type	Required	Description
regionMatchScore	KycMatchMatchScoreResult	false	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`.
localityMatch	any	false	none

Name	Type	Required	Description
» anonymous	KycMatchMatchResult	false	none

Name	Type	Required	Description
» anonymous	any	false	Indicates whether the locality of the customer’s address matches with the one on the Operator’s system.

Name	Type	Required	Description
localityMatchScore	KycMatchMatchScoreResult	false	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`.
countryMatch	any	false	none

Name	Type	Required	Description
» anonymous	KycMatchMatchResult	false	none

Name	Type	Required	Description
» anonymous	any	false	Indicates whether the country of the customer’s address matches with the one on the Operator’s system.

Name	Type	Required	Description
houseNumberExtensionMatch	any	false	none

Name	Type	Required	Description
» anonymous	KycMatchMatchResult	false	none

Name	Type	Required	Description
» anonymous	any	false	Indicates whether the house number extension of the customer’s address matches with the one on the Operator’s system.

Name	Type	Required	Description
birthdateMatch	any	false	none

Name	Type	Required	Description
» anonymous	KycMatchMatchResult	false	none

Name	Type	Required	Description
» anonymous	any	false	Indicates whether the birthdate of the customer matches with the one on the Operator’s system.

Name	Type	Required	Description
emailMatch	any	false	none

Name	Type	Required	Description
» anonymous	KycMatchMatchResult	false	none

Name	Type	Required	Description
» anonymous	any	false	Indicates whether the email address of the customer matches with the one on the Operator’s system.

Name	Type	Required	Description
emailMatchScore	KycMatchMatchScoreResult	false	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`.
genderMatch	any	false	none

Name	Type	Required	Description
» anonymous	KycMatchMatchResult	false	none

Name	Type	Required	Description
» anonymous	any	false	Indicates whether the gender of the customer matches with the one on the Operator’s system.

KycMatchErrorInfo

1
2
3
4
5


{
  "status": 0,
  "code": "string",
  "message": "string"
}

Name	Type	Required	Description
status	integer	true	HTTP response status code
code	string	true	Code given to this error
message	string	true	Detailed error description