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	false	Aggregator and Application Owner combination under which the application making the request is located.
client	string	false	Application that makes the request to consume the capacity.
scope	string	false	capabilities to be consumed
purpose	string	false	purpose for which the capability is to be consumed

ConsentsValidateRequest

 1
 2
 3
 4
 5
 6
 7
 8
 9
10


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

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

ConsentsErrorInfo

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

NumberVerificationVerifyRequest

1
2
3
4
5
6
7


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

Name	Type	Required	Description
referenceMsisdn	string	false	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	false	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

NumberVerificationErrorInfo

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

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

SimSwapErrorInfo

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

SimSwapCreateCheckSimSwap

1
2
3
4


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

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

SimSwapCreateSimSwapDate

1
2
3


{
  "phoneNumber": "+346661113334"
}

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