API Overview Resources Schemas

Schemas

bcAuthorizeResponse

1
2
3
4
5


{
  "auth_req_id": "d221eb9b-9d33-4fe9-ba41-9711ed0309ce",
  "expires_in": 360,
  "interval": 60
}

Name	Type	Required	Description
auth_req_id	string	true	REQUIRED. This is a unique identifier to identify the authentication request made by the Client.
expires_in	integer	true	The duration in seconds for which the authentication request is valid.
interval	integer	true	The minimum amount of time in seconds that the client SHOULD wait between polling to check if the authentication request has been completed.

postTokenResponse

1
2
3
4
5
6
7


{
  "access_token": "eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImtpZCI6Ik1VTkJaNa0ZGTWtKQlFqVkRPVFV4TlVWQ04wRTRPVEV5UWpGRFJFSTFNMFZEUXpBMU1UVTVNQSJ9.eyJpc3MiOiJodHRwczovL21hc21vdmlsLmV1LmF1dGgwLmNvbS8iLCJzdWIiOiJNN3A0YWUyeVdIN1N5bXdiVVlHcTJVdXdlVmp6WE5PR0BjbGllbnRzIiwiYXVkIjoiaHR0cHM6Ly9tYXNtb3ZpbC5ldS5hdXRoMC5jb20vYXBpL3YyLyIsImlhdCI6MTU1MDQyMDM3NywiZXhwIjoxNTUwNTA2Nzc3LCJhenAiOiJNN3A0YWUyeVdIN1N5bXdiVVlHcTJVdXdlVmp6WE5PRyIsInNjb3BlIjoicmVhZDpjbGllbnRfZ3JhbnRzIGNyZWF0ZTpjbGllbnRfZ3JhbnRzIGRlbGV0ZTpjbGllbnRfZ3JhbnRzIHVwZGF0ZTpjbGllbnRfZ3JhbnRzIHJlYWQ6dXNlcnMgdXBkYXRlOnVzZXJzIGRlbGV0ZTp1c2VycyBjcmVhdGU6dXNlcnMgcmVhZDp1c2Vyc19hcHBfbWV0YWRhdGEgdXBkYXRlOnVzZXJzX2FwcF9tZXRhZGF0YSBkZWxldGU6dXNlcnNfYXBwX21ldGFkYXRhIGNyZWF0ZTp1c2Vyc19hcHBfbWV0YWRhdGEgY3JlYXRlOnVzZXJfdGlja2V0cyByZWFkOmNsaWVudHMgdXBkYXRlOmNsaWVudHMgZGVsZXRlOmNsaWVudHMgY3JlYXRlOmNsaWVudHMgcmVhZDpjbGllbnRfa2V5cyB1cGRhdGU6Y2xpZW50X2tleXMgZGVsZXRlOmNsaWVudF9rZXlzIGNyZWF0ZTpjbGllbnRfa2V5cyByZWFkOmNvbm5lY3Rpb25zIHVwZGF0ZTpjb25uZWN0aW9ucyBkZWxldGU6Y29ubmVjdGlvbnMgY3JlYXRlOmNvbm5lY3Rpb25zIHJlYWQ6cmVzb3VyY2Vfc2VydmVycyB1cGRhdGU6cmVzb3VyY2Vfc2VydmVycyBkZWxldGU6cmVzb3VyY2Vfc2VydmVycyBjcmVhdGU6cmVzb3VyY2Vfc2VydmVycyByZWFkOmRldmljZV9jcmVkZW50aWFscyB1cGRhdGU6ZGV2aWNlX2NyZWRlbnRpYWxzIGRlbGV0ZTpkZXZpY2VfY3JlZGVudGlhbHMgY3JlYXRlOmRldmljZV9jcmVkZW50aWFscyByZWFkOnJ1bGVzIHVwZGF0ZTpydWxlcyBkZWxldGU6cnVsZXMgY3JlYXRlOnJ1bGVzIHJlYWQ6cnVsZXNfY29uZmlncyB1cGRhdGU6cnVsZXNfY29uZmlncyBkZWxldGU6cnVsZXNfY29uZmlncyByZWFkOmVtYWlsX3Byb3ZpZGVyIHVwZGF0ZTplbWFpbF9wcm92aWRlciBkZWxldGU6ZW1haWxfcHJvdmlkZXIgY3JlYXRlOmVtYWlsX3Byb3ZpZGVyIGJsYWNrbGlzdDp0b2tlbnMgcmVhZDpzdGF0cyByZWFkOnRlbmFudF9zZXR0aW5ncyB1cGRhdGU6dGVuYW50X3NldHRpbmdzIHJlYWQ6bG9ncyByZWFkOnNoaWVsZHMgY3JlYXRlOnNoaWVsZHMgZGVsZXRlOnNoaWVsZHMgdXBkYXRlOnRyaWdnZXJzIHJlYWQ6dHJpZ2dlcnMgcmVhZDpncmFudHMgZGVsZXRlOmdyYW50cyByZWFkOmd1YXJkaWFuX2ZhY3RvcnMgdXBkYXRlOmd1YXJkaWFuX2ZhY3RvcnMgcmVhZDpndWFyZGlhbl9lbnJvbGxtZW50cyBkZWxldGU6Z3VhcmRpYW5fZW5yb2xsbWVudHMgY3JlYXRlOmd1YXJkaWFuX2Vucm9sbG1lbnRfdGlja2V0cyByZWFkOnVzZXJfaWRwX3Rva2VucyBjcmVhdGU6cGFzc3dvcmRzX2NoZWNraW5nX2pvYiBkZWxldGU6cGFzc3dvcmRzX2NoZWNraW5nX2pvYiByZWFkOmN1c3RvbV9kb21haW5zIGRlbGV0ZTpjdXN0b21fZG9tYWlucyBjcmVhdGU6Y3VzdG9tX2RvbWFpbnMgcmVhZDplbWFpbF90ZW1wbGF0ZXMgY3JlYXRlOmVtYWlsX3RlbXBsYXRlcyB1cGRhdGU6ZW1haWxfdGVtcGxhdGVzIiwiZ3R5IjoiY2xpZW50LWNyZWRlbnRpYWxzIn0.h6GTIB8OMcMXDxyUzUW8tJ8LW7U_yIQfCshDuOW9E-_rd9NNRBxzsPhVHllawcB336Xfo3kwrVmS0KdkLGWz4BJo67R_4KXjQ_1VcmHD2WfzpS06fmjdV1DWZbd5dv3LBtPXEIYxWVzFSUcAlIKo5cstYlUWvb1weh56yBu26Y48UK5CIjwLmqAtlxL3kNcMI_PPuM-UmiQPeNe8cKPN4c7Tf_aVw38DcGydY53GIJ_fTeRvB5kb9CO4bs6g4iWOFZFFuLAluRFZsKcqJwNdW1RDYB_blmva5Q8JrBeU5TkbfdrWIL2QfdD93hjLFcWgE9z6txUz5opW2qkcMoQkLA",
  "scope": "read:client_grants create:client_grants delete:client_grants update:client_grants",
  "expires_in": 86400,
  "token_type": "Bearer",
  "refresh_token": "eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImtpZCI6Ik1VTkJNa0ZGTWtKQlFqVkRPVFV4TlVWQ04wRTRPVEV5UWpGRFJFSTFNMFZEUXpBMU1UVTVNQSJ9"
}

Name	Type	Required	Description
access_token	string	true	A token used by the client to make authenticated requests on behalf of the resource owner
scope	string	false	Scopes
expires_in	integer	false	none
token_type	string	true	none
refresh_token	string	false	A token used by the client to obtain a new access token without having to involve the resource owner.

KYC_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]

MatchResult

1

"true"

Name	Type	Required	Description
anonymous	string	false	none

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

MatchScoreResult

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`.

KYC_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	MatchResult	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	MatchResult	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	MatchScoreResult	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	MatchResult	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	MatchScoreResult	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	MatchResult	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	MatchScoreResult	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	MatchResult	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	MatchScoreResult	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	MatchResult	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	MatchScoreResult	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	MatchResult	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	MatchScoreResult	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	MatchResult	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	MatchScoreResult	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	MatchResult	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	MatchScoreResult	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	MatchResult	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	MatchScoreResult	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	MatchResult	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	MatchScoreResult	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	MatchResult	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	MatchResult	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	MatchScoreResult	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	MatchResult	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	MatchScoreResult	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	MatchResult	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	MatchResult	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	MatchResult	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	MatchResult	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	MatchScoreResult	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	MatchResult	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.

NumberVerificationRequestBody

1
2
3


{
  "phoneNumber": "+346661113334"
}

Name	Type	Required	Description
phoneNumber	PhoneNumber	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 ‘+’.
hashedPhoneNumber	string	false	Hashed phone number. SHA-256 (in hexadecimal representation) of the mobile phone number in E.164 format (starting with country code). Prefixed with ‘+’.

NumberVerificationMatchResponse

1
2
3


{
  "devicePhoneNumberVerified": true
}

Name	Type	Required	Description
devicePhoneNumberVerified	DevicePhoneNumberVerified	true	Number verification. True, if it matches

NumberVerificationShareResponse

1
2
3


{
  "devicePhoneNumber": "+346661113334"
}

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

DevicePhoneNumberVerified

1

true

Name	Type	Required	Description
anonymous	boolean	false	Number verification. True, if it matches

PhoneNumber

1

"+346661113334"

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 ‘+’.

SimSwapInfo

1
2
3


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

Name	Type	Required	Description
latestSimChange	string(date-time)¦null	true	Timestamp of latest SIM 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)

CheckSimSwapInfo

1
2
3


{
  "swapped": true
}

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

CreateCheckSimSwap

1
2
3
4


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

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

CreateSimSwapDate

1
2
3


{
  "phoneNumber": "+346661113334"
}

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

DeviceSwapInfo

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)

CreateDeviceSwapDate

1
2
3


{
  "phoneNumber": "+346661113334"
}

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

CreateCheckDeviceSwap

1
2
3
4


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

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

CheckDeviceSwapInfo

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.

ConsentInfoRetrieveStatusRequestBody

1
2
3
4
5
6
7
8


{
  "phoneNumber": "+346661113334",
  "scopes": [
    "location-verification:verify"
  ],
  "purpose": "dpv:FraudPreventionAndDetection",
  "requestCaptureUrl": true
}

Name	Type	Required	Description
phoneNumber	PhoneNumber	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 ‘+’.
scopes	ConsentInfoScopes	true	List of requested scopes.
purpose	ConsentInfoPurpose	true	The reason for which personal data will be processed by the API Consumer. CAMARA uses the W3C Data Privacy Vocabulary (DPV) to represent these purposes e.g. `dpv:FraudPreventionAndDetection` or `dpv:RequestedServiceProvision`.
requestCaptureUrl	boolean	true	A boolean flag indicating whether the API Consumer requests API Provider to return a Consent capture URL.

ConsentInfoScopes

1
2
3


[
  "location-verification:verify"
]

None

ConsentInfoPurpose

1

"dpv:FraudPreventionAndDetection"

Name	Type	Required	Description
anonymous	string	false	The reason for which personal data will be processed by the API Consumer. CAMARA uses the W3C Data Privacy Vocabulary (DPV) to represent these purposes e.g. `dpv:FraudPreventionAndDetection` or `dpv:RequestedServiceProvision`.

ConsentInfoRetrieveStatusResponseBody

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14


{
  "statusInfo": [
    {
      "scopes": [
        "location-verification:verify"
      ],
      "purpose": "dpv:FraudPreventionAndDetection",
      "statusValidForProcessing": true,
      "statusReason": "PENDING",
      "expirationDate": "2023-07-03T14:27:08.312+02:00"
    }
  ],
  "captureUrl": "string"
}

Name	Type	Required	Description
statusInfo	ConsentInfoStatusInfo	true	Provides information about the validity status of the requested data processing for the specified scope(s) and Purpose.
captureUrl	string(url)	false	URL where the User can provide the necessary Consent.

ConsentInfoStatusInfo

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11


[
  {
    "scopes": [
      "location-verification:verify"
    ],
    "purpose": "dpv:FraudPreventionAndDetection",
    "statusValidForProcessing": true,
    "statusReason": "PENDING",
    "expirationDate": "2023-07-03T14:27:08.312+02:00"
  }
]

Name	Type	Required	Description
anonymous	[ConsentInfoStatusInfoObject]	false	Provides information about the validity status of the requested data processing for the specified scope(s) and Purpose.

ConsentInfoStatusInfoObject

1
2
3
4
5
6
7
8
9


{
  "scopes": [
    "location-verification:verify"
  ],
  "purpose": "dpv:FraudPreventionAndDetection",
  "statusValidForProcessing": true,
  "statusReason": "PENDING",
  "expirationDate": "2023-07-03T14:27:08.312+02:00"
}

Name	Type	Required	Description
scopes	ConsentInfoScopes	true	List of requested scopes.
purpose	ConsentInfoPurpose	true	The reason for which personal data will be processed by the API Consumer. CAMARA uses the W3C Data Privacy Vocabulary (DPV) to represent these purposes e.g. `dpv:FraudPreventionAndDetection` or `dpv:RequestedServiceProvision`.
statusValidForProcessing	boolean	true	Boolean flag that shows the validity status of the requested data processing for the specified scope(s) and Purpose.
statusReason	string	false	This field must be present if `statusValidForProcessing` is `false`.
expirationDate	string(date-time)	false	The date and time at which the validity of the data processing is set to expire or has expired.

Property	Values
statusReason	one of [PENDING, REQUESTED, REVOKED, EXPIRED, OBJECTED]

ErrorInfo

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

errorAccessTokenResponse

1
2
3
4
5


{
  "error": "invalid_request",
  "error_description": "string",
  "error_uri": "string"
}

Name	Type	Required	Description
error	string	true	A single error code
error_description	string	false	A human-readable text providing additional information, used to assist in the understanding and resolution of the error occurred
error_uri	string	false	none

Property	Values
error	one of [invalid_request, access_denied, invalid_client, invalid_grant, unauthorized_client, unauthorized_grant_type, invalid_scope, error_description, error_uri]

errorPostTokenResponse

1
2
3
4
5


{
  "error": "invalid_request",
  "error_description": "string",
  "error_uri": "string"
}

Name	Type	Required	Description
error	string	true	A single error code
error_description	string	false	A human-readable text providing additional information, used to assist in the understanding and resolution of the error occurred
error_uri	string	false	none

Property	Values
error	one of [authorization_pending, invalid_request, access_denied, invalid_client, invalid_grant, unauthorized_client, unauthorized_grant_type, invalid_scope, error_description, error_uri]

KYCAgeVerificationVerifyRequestBody

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14


{
  "ageThreshold": 120,
  "phoneNumber": "+346661113334",
  "idDocument": "string",
  "name": "string",
  "givenName": "string",
  "familyName": "string",
  "middleNames": "string",
  "familyNameAtBirth": "string",
  "birthdate": "2019-08-24",
  "email": "user@example.com",
  "includeContentLock": false,
  "includeParentalControl": false
}

Name	Type	Required	Description
ageThreshold	AgeThreshold	true	The age to be verified. The indicated range is a global definition of maximum and minimum values allowed to be requested. It is important to note that this range might be more restrictive in some implementations due to local regulations of a country i.e. A country does not allow to request for an age under 18. This limitation must be informed during the onboarding process.
phoneNumber	PhoneNumber	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	IdDocument	false	Id number associated to the official identity document in the country. It may contain alphanumeric characters.
name	Name	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	GivenName	false	First/given name or compound first/given name of the customer.
familyName	FamilyName	false	Last name, family name, or surname of the customer.
middleNames	MiddleNames	false	Middle name/s of the customer.
familyNameAtBirth	FamilyNameAtBirth	false	Last/family/sur- name at birth of the customer.
birthdate	Birthdate	false	The birthdate of the customer, in RFC 3339 / ISO 8601 calendar date format (YYYY-MM-DD).
email	Email	false	Email address of the customer in the RFC specified format (local-part@domain).
includeContentLock	IncludeContentLock	false	If this parameter is included in the request with value `true`, the response property `contentLock` will be returned. If it is not included or its value is `false`, the response property will not be returned.
includeParentalControl	IncludeParentalControl	false	If this parameter is included in the request with value `true`, the response property `parentalControl` will be returned. If it is not included or its value is `false`, the response property will not be returned.

AgeThreshold

1

120

Name	Type	Required	Description
anonymous	integer	false	The age to be verified. The indicated range is a global definition of maximum and minimum values allowed to be requested. It is important to note that this range might be more restrictive in some implementations due to local regulations of a country i.e. A country does not allow to request for an age under 18. This limitation must be informed during the onboarding process.

IdDocument

1

"string"

Name	Type	Required	Description
anonymous	string	false	Id number associated to the official identity document in the country. It may contain alphanumeric characters.

Name

1

"string"

Name	Type	Required	Description
anonymous	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

1

"string"

Name	Type	Required	Description
anonymous	string	false	First/given name or compound first/given name of the customer.

FamilyName

1

"string"

Name	Type	Required	Description
anonymous	string	false	Last name, family name, or surname of the customer.

MiddleNames

1

"string"

Name	Type	Required	Description
anonymous	string	false	Middle name/s of the customer.

FamilyNameAtBirth

1

"string"

Name	Type	Required	Description
anonymous	string	false	Last/family/sur- name at birth of the customer.

Birthdate

1

"2019-08-24"

Name	Type	Required	Description
anonymous	string(date)	false	The birthdate of the customer, in RFC 3339 / ISO 8601 calendar date format (YYYY-MM-DD).

Email

1

"user@example.com"

Name	Type	Required	Description
anonymous	string(email)	false	Email address of the customer in the RFC specified format (local-part@domain).

IncludeContentLock

1

false

Name	Type	Required	Description
anonymous	boolean	false	If this parameter is included in the request with value `true`, the response property `contentLock` will be returned. If it is not included or its value is `false`, the response property will not be returned.

IncludeParentalControl

1

false

Name	Type	Required	Description
anonymous	boolean	false	If this parameter is included in the request with value `true`, the response property `parentalControl` will be returned. If it is not included or its value is `false`, the response property will not be returned.

KYCAgeVerificationVerifyResponseBody

1
2
3
4
5
6
7


{
  "ageCheck": "true",
  "verifiedStatus": true,
  "identityMatchScore": 100,
  "contentLock": "true",
  "parentalControl": "true"
}

Name	Type	Required	Description
ageCheck	AgeCheck	true	Indicate `"true"` when the age of the user is the same age or older than the age threshold (age >= age threshold), and `"false"` if not (age < age threshold). If the API Provider doesn’t have enough information to perform the validation, a `not_available` can be returned.
verifiedStatus	VerifiedStatus	false	Indicate `true` if the information provided has been compared against information based on an identification document legally accepted as an age verification document (Note), otherwise indicate `false`. Note: Depending on the country, credit-check or other mechanism can be used instead of official identification for Age Verification. For details, please contact API Provider.
identityMatchScore	IdentityMatchScore	false	The overall score of identity information available in the API Provider, information either provided in the request body comparing it to the one that the API Provider holds or directly using internal API Provider’s information. It is optional for the API Provider to return the Identity match score.
contentLock	ContentLock	false	Indicate `"true"` if the subscription associated with the phone number has any kind of content lock (i.e certain web content blocked) and `"false"` if not. If the information is not available the value `not_available` can be returned.
parentalControl	ParentalControl	false	Indicate `"true"` if the subscription associated with the phone number has any kind of parental control activated and `"false"` if not. If the information is not available the value `not_available` can be returned.

AgeCheck

1

"true"

Name	Type	Required	Description
anonymous	string	false	Indicate `"true"` when the age of the user is the same age or older than the age threshold (age >= age threshold), and `"false"` if not (age < age threshold). If the API Provider doesn’t have enough information to perform the validation, a `not_available` can be returned.

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

VerifiedStatus

1

true

Name	Type	Required	Description
anonymous	boolean	false	Indicate `true` if the information provided has been compared against information based on an identification document legally accepted as an age verification document (Note), otherwise indicate `false`. Note: Depending on the country, credit-check or other mechanism can be used instead of official identification for Age Verification. For details, please contact API Provider.

IdentityMatchScore

1

100

Name	Type	Required	Description
anonymous	integer	false	The overall score of identity information available in the API Provider, information either provided in the request body comparing it to the one that the API Provider holds or directly using internal API Provider’s information. It is optional for the API Provider to return the Identity match score.

ContentLock

1

"true"

Name	Type	Required	Description
anonymous	string	false	Indicate `"true"` if the subscription associated with the phone number has any kind of content lock (i.e certain web content blocked) and `"false"` if not. If the information is not available the value `not_available` can be returned.

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

ParentalControl

1

"true"

Name	Type	Required	Description
anonymous	string	false	Indicate `"true"` if the subscription associated with the phone number has any kind of parental control activated and `"false"` if not. If the information is not available the value `not_available` can be returned.

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

TenureRequest

1
2
3
4


{
  "phoneNumber": "+346661113334",
  "tenureDate": "2023-07-03"
}

Name	Type	Required	Description
phoneNumber	PhoneNumber	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 ‘+’.
tenureDate	string(date)	true	The date, in RFC 3339 / ISO 8601 compliant format “YYYY-MM-DD”, from which continuous tenure is required to be confirmed. Must not be in the future.

TenureResponse

1
2
3
4


{
  "tenureDateCheck": true,
  "contractType": "PAYM"
}

Name	Type	Required	Description
tenureDateCheck	boolean	true	`true` when the identified mobile subscription has had valid tenure since `tenureDate`, otherwise `false`
contractType	string	false	If exists, populated with: - `PAYG` - prepaid (pay-as-you-go) account - `PAYM` - contract account - `Business` - Business (enterprise) account This attribute may be omitted from the response set if the information is not available

Property	Values
contractType	one of [PAYG, PAYM, Business]