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

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)	false	Period in hours to be checked for device swap. Valid range: 1-2400 hours.

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.

DeviceSwapApiError

1
2
3
4
5
6


{
  "code": "string",
  "title": "string",
  "ref": "string",
  "details": "string"
}

Name	Type	Required	Description
code	string	true	code of the error
title	string	true	title of the error
ref	string	true	ref of the error
details	string	true	details of the error

KycMatchSafeString

1

"string"

Name	Type	Required	Description
anonymous	string	false	none

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": "ES",
  "houseNumberExtension": "string",
  "birthdate": "2019-08-24",
  "email": "string",
  "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	KycMatchSafeString	false	Id number associated to the official identity document in the country. It may contain alphanumeric characters.
name	KycMatchSafeString	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	KycMatchSafeString	false	First/given name or compound first/given name of the customer.
familyName	KycMatchSafeString	false	Last name, family name, or surname of the customer.
nameKanaHankaku	KycMatchSafeString	false	Complete name of the customer in Hankaku-Kana format (reading of name) for Japan.
nameKanaZenkaku	KycMatchSafeString	false	Complete name of the customer in Zenkaku-Kana format (reading of name) for Japan.
middleNames	KycMatchSafeString	false	Middle name/s of the customer.
familyNameAtBirth	KycMatchSafeString	false	Last/family/sur- name at birth of the customer.
address	KycMatchSafeString	false	Complete billingAddress 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	KycMatchSafeString	false	Name of the street of the customer’s billingAddress. It should not include the type of the street.
streetNumber	KycMatchSafeString	false	The street number of the customer’s billingAddress. Number identifying a specific property on the ‘streetName’.
postalCode	KycMatchSafeString	false	Zip code or postal code
region	KycMatchSafeString	false	Region/prefecture of the customer’s billingAddress
locality	KycMatchSafeString	false	Locality of the customer’s billingAddress
country	KycMatchSafeString	false	Country of the customer’s billingAddress. Format ISO 3166-1 alpha-2
houseNumberExtension	KycMatchSafeString	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	KycMatchSafeString(email)	false	Email billingAddress 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	KycMatchMatchResult	false	Indicates whether Id number associated to the ID document of the customer matches with the one on the Operator’s system.
nameMatch	KycMatchMatchResult	false	Indicates whether the complete name of the customer matches with the one on the Operator’s system.
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	KycMatchMatchResult	false	Indicates whether First name/given name of the customer matches with the one on the Operator’s system.
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	KycMatchMatchResult	false	Indicates whether last name/ family name/ surname of the customer matches with the one on the Operator’s system.
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	KycMatchMatchResult	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.
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	KycMatchMatchResult	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.
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	KycMatchMatchResult	false	Indicates whether the middle names of the customer matches with the one on the Operator’s system.
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	KycMatchMatchResult	false	Indicates whether the Family Name At Birth of the customer matches with the one on the Operator’s system.
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	KycMatchMatchResult	false	Indicates whether complete billingAddress of the customer matches with the one on the Operator’s system.
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	KycMatchMatchResult	false	Indicates whether the street name of the customer matches with the one on the Operator’s system.
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	KycMatchMatchResult	false	Indicates whether the street number of the customer matches with the one on the Operator’s system.
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	KycMatchMatchResult	false	Indicates whether the postal code / zip code of the customer matches with the one on the Operator’s system.
regionMatch	KycMatchMatchResult	false	Indicates whether the region of the customer’s billingAddress matches with the one on the Operator’s system.
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	KycMatchMatchResult	false	Indicates whether the locality of the customer’s billingAddress matches with the one on the Operator’s system.
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	KycMatchMatchResult	false	Indicates whether the country of the customer’s billingAddress matches with the one on the Operator’s system.
houseNumberExtensionMatch	KycMatchMatchResult	false	Indicates whether the house number extension of the customer’s billingAddress matches with the one on the Operator’s system.
birthdateMatch	KycMatchMatchResult	false	Indicates whether the birthdate of the customer matches with the one on the Operator’s system.
emailMatch	KycMatchMatchResult	false	Indicates whether the email billingAddress of the customer matches with the one on the Operator’s system.
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	KycMatchMatchResult	false	Indicates whether the gender of the customer matches with the one on the Operator’s system.

KycMatchApiError

1
2
3
4
5
6


{
  "code": "string",
  "title": "string",
  "ref": "string",
  "details": "string"
}

Name	Type	Required	Description
code	string	true	code of the error
title	string	true	title of the error
ref	string	true	ref of the error
details	string	true	details of the error

KycAgeVerificationVerifyRequestBody

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


{
  "ageThreshold": 120,
  "phoneNumber": "+123456789",
  "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	KycAgeVerificationAgeThreshold	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	KycAgeVerificationPhoneNumber	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 ‘+’.
idDocument	KycAgeVerificationIdDocument	false	Id number associated to the official identity document in the country. It may contain alphanumeric characters.
name	KycAgeVerificationName	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	KycAgeVerificationGivenName	false	First/given name or compound first/given name of the customer.
familyName	KycAgeVerificationFamilyName	false	Last name, family name, or surname of the customer.
middleNames	KycAgeVerificationMiddleNames	false	Middle name/s of the customer.
familyNameAtBirth	KycAgeVerificationFamilyNameAtBirth	false	Last/family/sur- name at birth of the customer.
birthdate	KycAgeVerificationBirthdate	false	The birthdate of the customer, in RFC 3339 / ISO 8601 calendar date format (YYYY-MM-DD).
email	KycAgeVerificationEmail	false	Email address of the customer in the RFC specified format (local-part@domain).
includeContentLock	KycAgeVerificationIncludeContentLock	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	KycAgeVerificationIncludeParentalControl	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.

KycAgeVerificationAgeThreshold

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.

KycAgeVerificationPhoneNumber

1

"+123456789"

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

KycAgeVerificationIdDocument

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.

KycAgeVerificationName

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.

KycAgeVerificationGivenName

1

"string"

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

KycAgeVerificationFamilyName

1

"string"

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

KycAgeVerificationMiddleNames

1

"string"

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

KycAgeVerificationFamilyNameAtBirth

1

"string"

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

KycAgeVerificationBirthdate

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

KycAgeVerificationEmail

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

KycAgeVerificationIncludeContentLock

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.

KycAgeVerificationIncludeParentalControl

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	KycAgeVerificationAgeCheck	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	KycAgeVerificationVerifiedStatus	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	KycAgeVerificationIdentityMatchScore	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	KycAgeVerificationContentLock	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	KycAgeVerificationParentalControl	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.

KycAgeVerificationAgeCheck

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]

KycAgeVerificationVerifiedStatus

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.

KycAgeVerificationIdentityMatchScore

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.

KycAgeVerificationContentLock

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]

KycAgeVerificationParentalControl

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]

KycAgeVerificationApiError

1
2
3
4
5
6


{
  "code": "string",
  "title": "string",
  "ref": "string",
  "details": "string"
}

Name	Type	Required	Description
code	string	true	code of the error
title	string	true	title of the error
ref	string	true	ref of the error
details	string	true	details of the error

KycTenureApiError

1
2
3
4
5
6


{
  "code": "string",
  "title": "string",
  "ref": "string",
  "details": "string"
}

Name	Type	Required	Description
code	string	true	code of the error
title	string	true	title of the error
ref	string	true	ref of the error
details	string	true	details of the error

KycTenureTenure

1
2
3
4


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

Name	Type	Required	Description
phoneNumber	KycTenurePhoneNumber	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 ‘+’.
tenureDate	string(date)	true	The date, in RFC 3339 / ISO 8601 compliant format “YYYY-MM-DD”, from which continuous tenure of the identified network subscriber is required to be confirmed. The date must not be in the future (i.e., it must be less than or equal to the current date). If a future date is provided, a `400 INVALID_ARGUMENT` error will be returned.

KycTenurePhoneNumber

1

"+123456789"

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

KycTenureTenureInfo

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]

ConsentInfoXCorrelator

1

"b4333c46-49c0-4f62-80d7-f0ef930f1c46"

Name	Type	Required	Description
anonymous	string	false	Value for the x-correlator

ConsentInfoPhoneNumber

1

"+123456789"

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

ConsentInfoRetrieveStatusRequestBody

1
2
3
4
5
6
7
8
9


{
  "phoneNumber": "+123456789",
  "clientId": "api-consumer",
  "scopes": [
    "location-verification:verify"
  ],
  "purpose": "dpv:FraudPreventionAndDetection",
  "requestCaptureUrl": true
}

Name	Type	Required	Description
phoneNumber	ConsentInfoPhoneNumber	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 ‘+’.
clientId	string	true	The client identifier of the API Consumer, as registered with the API Provider.
scopes	ConsentInfoScopes	true	List of requested scopes. The scope is a string that represents the access rights that the API Consumer is requesting from the User.
purpose	ConsentInfoPurpose	true	The reason for which personal data will be processed by the API Consumer. CAMARA defines a standard set of Purposes which can be used by API Consumers to specify the reason for their intended personal data processing. 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. * `true` - If set to `true` the API will include a `captureUrl` in the response body if applicable. * `false` - The API will omit the Consent capture URL from the response.

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 defines a standard set of Purposes which can be used by API Consumers to specify the reason for their intended personal data processing. 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": "https://example.org/consent-capture-url"
}

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. It contains details of whether the processing of the data is currently valid and, if not, the reason why. The expiration date of the validity may be also provided if applicable. More than one array item may be required for the requested scope(s) and Purpose, e.g. when the requested scopes relate to multiple APIs.
captureUrl	string(url)	false	URL where the User can provide the necessary Consent. This field is only present in the API response if the API Consumer requests it and if the following conditions are met: - `statusInfo[].statusValidForProcessing` is `false`, and - `statusInfo[].statusReason` is `PENDING`, `REQUESTED` or `EXPIRED`. Please note that this field is only applicable when the User Consent is required to enable valid data processing. A unique URL is provided to authorise all items in the statusInfo list that require user action.

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. It contains details of whether the processing of the data is currently valid and, if not, the reason why. The expiration date of the validity may be also provided if applicable. More than one array item may be required for the requested scope(s) and Purpose, e.g. when the requested scopes relate to multiple APIs.

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. The scope is a string that represents the access rights that the API Consumer is requesting from the User.
purpose	ConsentInfoPurpose	true	The reason for which personal data will be processed by the API Consumer. CAMARA defines a standard set of Purposes which can be used by API Consumers to specify the reason for their intended personal data processing. 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. * `true` - indicates that the current status is valid and permits the requested data processing. * `false` - indicates that the requested data processing is not permitted. The reason for this is provided in the `statusReason` field.
statusReason	string	false	This field must be present if `statusValidForProcessing` is `false`. It indicates the reason why the requested data processing is not permitted for the specified scope(s) and Purpose. It provides API Consumers with additional context on the current validity status, helping them to understand its applicability and the next steps they may need to take. It is particularly useful for determining whether the API Consumer should prompt the User to take action, such as providing Consent or renewing an existing Consent. Possible values are: - `PENDING`: The requested data processing has not yet been established or fully validated under the applicable privacy regulations. For example, the User has not yet provided Consent when it is required. - `REQUESTED`: The permission for the requested data processing has been submitted but has not yet been granted or confirmed. This is common when the API Consumer has initiated a request for Consent capture, but the User has not yet completed the process. For example, this occurs when a notice prompting the User to provide Consent has been displayed, but they have not yet made a decision. - `REVOKED`: The User has actively withdrawn their permission for the requested data processing after previously opting in. For example, the User revokes their Consent for the data processing. - `OBJECTED`: The user has opted out of the requested data processing, despite a previous explicit opt-in not being required. This is common when the User has exercised their right to object to data processing under the applicable privacy regulations. - `EXPIRED`: When applicable, the validity of the data processing has ceased due to the passage of time or a pre-defined condition. This is common for time-limited Consents.
expirationDate	string(date-time)	false	The date and time at which the validity of the data processing is set to expire or has expired. It applies mainly to time-limited Consents, or other cases where a specific duration of validity is defined for the data processing. This field is only applicable: - if `statusValidForProcessing` is `true` (indicating a future expiration), or - if `statusValidForProcessing` is `false` and `statusReason` is `EXPIRED` (indicating the past expiration date). 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).

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

ConsentInfoApiError

1
2
3
4
5
6


{
  "code": "string",
  "title": "string",
  "ref": "string",
  "details": "string"
}

Name	Type	Required	Description
code	string	true	code of the error
title	string	true	title of the error
ref	string	true	ref of the error
details	string	true	details of the error