API Overview Resources Schemas

Schemas

ConsentsCreateRequest

1
2
3
4
5
6


{
  "application": "alphabet-xxxxx",
  "client": "youtube",
  "scope": "SimSwap",
  "purpose": "FraudPreventionAndDetection"
}

Name	Type	Required	Description
application	string	true	Aggregator and Application Owner combination under which the application making the request is located.
client	string	true	Application that makes the request to consume the capacity.
scope	string	true	capabilities to be consumed
purpose	string	true	purpose for which the capability is to be consumed

ConsentsValidateRequest

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11


{
  "msisdn": "+123456789",
  "application": "alphabet-xxxxx",
  "client": "youtube",
  "scopes": [
    "SimSwap",
    "NumberVerification",
    "SIMCardChange"
  ],
  "purpose": "FraudPreventionAndDetection"
}

Name	Type	Required	Description
msisdn	string	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 ‘+’.
application	string	true	Aggregator and Application Owner combination under which the application making the request is located.
client	string	true	Application that makes the request to consume the capacity.
scopes	[string]	true	capabilities to be consumed
purpose	string	true	purpose for which the capability is to be consumed

ConsentsValidateResponse

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


[
  {
    "id": "SimSwap_FraudPreventionAndDetection_Agregador1App1",
    "scope": "FraudPreventionAndDetection:SimSwap",
    "status": "ACCEPTED"
  },
  {
    "id": "NumberVerification_FraudPreventionAndDetection_Agregador2App2",
    "scope": "FraudPreventionAndDetection:NumberVerification",
    "status": "PENDING"
  }
]

Name	Type	Required	Description
id	string	false	Unique identifier combining scope, purpose, aggregator and application
scope	string	false	Formatted as purpose:scope
status	string	false	Consent status

Property	Values
status	one of [ACCEPTED, PENDING, REJECTED]

ConsentsApiError

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

NumberVerificationVerifyRequest

1
2
3
4
5
6
7


{
  "referenceMsisdn": "+123456789",
  "evidence": {
    "type": "PLAIN",
    "value": "string"
  }
}

Name	Type	Required	Description
referenceMsisdn	string	true	The MSISDN assigned by the network and extracted from the authentication token. 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 ‘+’.
evidence	object	true	none
» type	string	true	Type of evidence provided: - `PLAIN`: The MSISDN is provided in plain text. - `HASHED_SHA256`: The MSISDN is provided as a hashed value. SHA-256 (in hexadecimal representation) of the mobile phone number in E.164 format (starting with country code). Prefixed with ‘+’.
» value	string	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 the E.164 standard, prefixed with ‘+’.

Property	Values
type	one of [PLAIN, HASHED_SHA256]

NumberVerificationMatchResponse

1
2
3


{
  "devicePhoneNumberVerified": true
}

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

NumberVerificationDevicePhoneNumberVerified

1

true

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

NumberVerificationApiError

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

SimSwapSimSwapInfo

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)

SimSwapCheckSimSwapInfo

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.

SimSwapPhoneNumber

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

SimSwapCreateCheckSimSwap

1
2
3
4


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

Name	Type	Required	Description
phoneNumber	SimSwapPhoneNumber	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 SIM swap.

SimSwapCreateSimSwapDate

1
2
3


{
  "phoneNumber": "+346661113334"
}

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

SimSwapApiError

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

OperativeApplicationClientResponse

1
2
3
4
5
6


{
  "appOwnerId": "string",
  "client": {
    "appClientId": "string"
  }
}

Name	Type	Required	Description
appOwnerId	string	false	AppOwner identifier.
client	OperativeClientResponse	false	none

OperativeClientResponse

1
2
3


{
  "appClientId": "string"
}

Name	Type	Required	Description
appClientId	string	false	Client identifier.

OperativeCreateApplicationRequest

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11


{
  "appOwnerName": "string",
  "appOwnerEmail": "user@example.com",
  "appOwnerDescription": "string",
  "appClientSecret": "string",
  "appClientRedirectURL": [
    "http://example.com"
  ],
  "appClientName": "string",
  "appClientJwksUri": "http://example.com"
}

Name	Type	Required	Description
appOwnerName	string	true	The Aggregator Name plus the AppOwner ID.
appOwnerEmail	string(email)	false	The AppOwner’s contactMedium.emailAddress.
appOwnerDescription	string	true	Trading Name, organizationType and tax Number.
appClientSecret	string	true	Application Client Secret.
appClientRedirectURL	[string]	false	Application redirectURL.
appClientName	string	true	Application commercialName.
appClientJwksUri	string(uri)	false	Application Client jwks Uri.

OperativeCreateProductOrderRequest

1
2
3
4


{
  "scope": "string",
  "purpose": "string"
}

Name	Type	Required	Description
scope	string	true	Defines the scope of the API.
purpose	string	true	Defines the purpose of the API.

OperativeApiError

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