| openapi: 3.0.3
|
| info:
|
| title: Device Swap
|
| description: |
|
| This API allows to check the last time that the phone (device) - phone number association has changed
|
|
|
|
|
|
|
| The Device Swap API performs real-time checks on the last Device Swap event, providing real-time information about whether the SIM card associated with a user's phone number has been transferred to a different physical device.
|
|
|
| Device Swap information can be invaluable for enhancing security, fraud detection, and ensuring compliance with regulatory requirements in various applications, apart from providing useful information of device upgrade trends in user segments.
|
|
|
| This API is used by an application to get information about a mobile line's latest Device Swap date. It can be easily integrated and used through this secured API and allows API consumers to get this information in an easy and secured way. The API provides management of 2 endpoints answering 2 distinct questions:
|
|
|
| * When did the last Device Swap occur?
|
| * Has a Device Swap occurred during the last n hours?
|
|
|
|
|
|
|
| **Device Swap:** A Device Swap is a process in which the association between a user's mobile phone number (MSISDN) and a device (IMEI) is created for the first time or changes for any reasons.
|
|
|
|
|
|
|
| The Device Swap API provides a programmable interface for developers and other users (capabilities consumers) to request the last date of a device swap performed on the mobile line, or, to check whether a device swap has been performed during a past period.
|
|
|
| The API provides 2 operations:
|
|
|
| - POST retrieve-date: Provides timestamp of latest device swap, if any, for a given phone number.
|
| - If no swap has been performed and the network operator supports unlimited DeviceSwap monitoring timeframe, the API will return the first phone number usage in a device (the timestamp of the first time that the phone number was connected to the network, it is, the first time that the SIM is installed in a device).
|
| - If the latest device swap date (or the first phone number usage, if no device swap) cannot be communicated due to local regulations (or Network Operator internal privacy policies) preventing the safekeeping of the information for longer than the stated period, a `null` value will be returned. Optionally, a `monitoredPeriod` could be provided to indicate monitored time frame (in days) supported by the Network Operator. In this case the response must be treated as "there were no device swap events during 'monitoredPeriod'. Either the parameter is optional, it is recommended to support it in DeviceSwap implementations.
|
| - POST check: Checks if device swap has been performed during a past period (defined in the request with 'maxAge' attribute) for a given phone number, the API will return boolean response (true/false), indicating that the device has been swapped or not in the specified period. In case the phone number has never been installed in a device, or no data is available in the operators records (e.g. database error), API will return a 422 error.
|
|
|
| # Identifying the phone number from the access token
|
|
|
| This API requires the API consumer to identify a phone number as the subject of the API. There is 2 ways to retrieve it depending on the authorization flow used:
|
| - When the API is invoked using a two-legged access token, the phone number will be identified from the optional `phoneNumber` identifier, which therefore MUST be provided.
|
| - When a three-legged access token is used however, this optional `phoneNumber` identifier MUST NOT be provided, as the phone number will be uniquely identified from the access token.
|
|
|
| This approach simplifies API usage for API consumers using a three-legged access token to invoke the API by relying on the information that is associated with the access token and was identified during the authentication process.
|
|
|
| ## Error handling:
|
|
|
| - If the phoneNumber cannot be identified from the access token and the optional `phoneNumber` identifier is not included in the request, then the server will return an error with the `422 MISSING_IDENTIFIER` error code.
|
|
|
| - If the phoneNumber can be identified from the access token and the optional `phoneNumber` identifier is also included in the request, then the server will return an error with the `422 UNNECESSARY_IDENTIFIER` error code. This will be the case even if the same device is identified by these two methods, as the server is unable to make this comparison.
|
|
|
| # Authorization and authentication
|
|
|
| The "Camara Security and Interoperability Profile" provides details of how an API consumer requests an access token. Please refer to Identity and Consent Management (https://github.com/camaraproject/IdentityAndConsentManagement/) for the released version of the profile.
|
|
|
| The specific authorization flows to be used will be agreed upon during the onboarding process, happening between the API consumer and the API provider, taking into account the declared purpose for accessing the API, whilst also being subject to the prevailing legal framework dictated by local legislation.
|
|
|
| In cases where personal data is processed by the API and users can exercise their rights through mechanisms such as opt-in and/or opt-out, the use of three-legged access tokens is mandatory. This ensures that the API remains in compliance with privacy regulations, upholding the principles of transparency and user-centric privacy-by-design.
|
|
|
|
|
|
|
| The list of error codes in this API specification is not exhaustive. Therefore the API specification may not document some non-mandatory error statuses as indicated in `CAMARA API Design Guide`.
|
|
|
| Please refer to the `CAMARA_common.yaml` of the Commonalities Release associated to this API version for a complete list of error responses. The applicable Commonalities Release can be identified in the `API Readiness Checklist` document associated to this API version.
|
|
|
| As a specific rule, error `501 - NOT_IMPLEMENTED` can be only a possible error response if it is explicitly documented in the API.
|
|
|
| license:
|
| name: Apache 2.0
|
| url: https://www.apache.org/licenses/LICENSE-2.0.html
|
| version: wip
|
| x-camara-commonalities: 0.6
|
|
|
| externalDocs:
|
| description: Product documentation at CAMARA
|
| url: https://github.com/camaraproject/DeviceSwap
|
|
|
| servers:
|
| - url: '{apiRoot}/device-swap/vwip'
|
| variables:
|
| apiRoot:
|
| default: http://localhost:9091
|
| description: API root, defined by the service provider, e.g. `api.example.com` or `api.example.com/somepath`
|
| tags:
|
| - name: Retrieve Device Swap Date
|
| description: Receive the last date in which the device of the end-user was swapped
|
| - name: Check Device Swap
|
| description: Validate if the SIM of the end-user has been installed in a different device during a past period
|
| paths:
|
| /retrieve-date:
|
| post:
|
| tags:
|
| - Retrieve Device Swap Date
|
| summary: Get last device swap date
|
| description: Get timestamp of last device swap for a mobile user account provided with phone number.
|
| operationId: retrieveDeviceSwapDate
|
| security:
|
| - openId:
|
| - device-swap
|
| - openId:
|
| - device-swap:retrieve-date
|
| parameters:
|
| - $ref: '#/components/parameters/x-correlator'
|
| requestBody:
|
| description: |
|
| Create a device swap date request for a phone number.
|
| content:
|
| application/json:
|
| schema:
|
| $ref: "#/components/schemas/CreateDeviceSwapDate"
|
| examples:
|
| RETRIEVE_3LEGS:
|
| $ref: "#/components/examples/RETRIEVE_3LEGS"
|
| RETRIEVE_2LEGS:
|
| $ref: "#/components/examples/RETRIEVE_2LEGS"
|
| required: true
|
| responses:
|
| "200":
|
| description: Contains information about Device swap change
|
| headers:
|
| x-correlator:
|
| $ref: '#/components/headers/x-correlator'
|
| content:
|
| application/json:
|
| schema:
|
| $ref: "#/components/schemas/DeviceSwapInfo"
|
| examples:
|
| RETRIEVE_DATE:
|
| $ref: "#/components/examples/RETRIEVE_DATE"
|
| RETRIEVE_MONITORED_PERIOD:
|
| $ref: "#/components/examples/RETRIEVE_MONITORED_PERIOD"
|
| RETRIEVE_MONITORED_NULL:
|
| $ref: "#/components/examples/RETRIEVE_MONITORED_NULL"
|
| "400":
|
| $ref: "#/components/responses/Generic400"
|
| "401":
|
| $ref: "#/components/responses/Generic401"
|
| "403":
|
| $ref: "#/components/responses/Generic403"
|
| "404":
|
| $ref: "#/components/responses/Generic404"
|
| "422":
|
| $ref: "#/components/responses/Generic422"
|
| /check:
|
| post:
|
| tags:
|
| - Check Device Swap
|
| summary: Check last device swap date
|
| description: Check if device swap has been performed during a past period
|
| operationId: checkDeviceSwap
|
| security:
|
| - openId:
|
| - device-swap
|
| - openId:
|
| - device-swap:check
|
| parameters:
|
| - $ref: '#/components/parameters/x-correlator'
|
| requestBody:
|
| required: true
|
| description: |
|
| Create a check device swap request for a phone number.
|
| content:
|
| application/json:
|
| schema:
|
| $ref: "#/components/schemas/CreateCheckDeviceSwap"
|
| examples:
|
| CHECK_3LEGS:
|
| $ref: "#/components/examples/CHECK_3LEGS"
|
| CHECK_2LEGS:
|
| $ref: "#/components/examples/CHECK_2LEGS"
|
| responses:
|
| "200":
|
| description: Returns whether a device swap has been performed during a past period
|
| headers:
|
| x-correlator:
|
| $ref: '#/components/headers/x-correlator'
|
| content:
|
| application/json:
|
| schema:
|
| $ref: "#/components/schemas/CheckDeviceSwapInfo"
|
| "400":
|
| $ref: "#/components/responses/Generic400Check"
|
| "401":
|
| $ref: "#/components/responses/Generic401"
|
| "403":
|
| $ref: "#/components/responses/Generic403"
|
| "404":
|
| $ref: "#/components/responses/Generic404"
|
| "422":
|
| $ref: "#/components/responses/Generic422"
|
| components:
|
| securitySchemes:
|
| openId:
|
| type: openIdConnect
|
| openIdConnectUrl: https://example.com/.well-known/openid-configuration
|
| parameters:
|
| x-correlator:
|
| name: x-correlator
|
| in: header
|
| description: Correlation id for the different services
|
| schema:
|
| $ref: "#/components/schemas/XCorrelator"
|
| headers:
|
| x-correlator:
|
| description: Correlation id for the different services
|
| schema:
|
| $ref: "#/components/schemas/XCorrelator"
|
| schemas:
|
| XCorrelator:
|
| type: string
|
| pattern: ^[a-zA-Z0-9-_:;.\/<>{}]{0,256}$
|
| example: "b4333c46-49c0-4f62-80d7-f0ef930f1c46"
|
| DeviceSwapInfo:
|
| type: object
|
| required:
|
| - latestDeviceChange
|
| properties:
|
| latestDeviceChange:
|
| type: string
|
| format: date-time
|
| description: Timestamp of latest device swap performed. It must follow [RFC 3339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.6) and must have time zone.
|
| nullable: true
|
| example: "2023-07-03T14:27:08.312+02:00"
|
| monitoredPeriod:
|
| type: integer
|
| description: Timeframe in days for device change supervision for the phone number. It could be valued in the response if the latest Device swap occurred before this monitored period.
|
| example: 120
|
| CreateDeviceSwapDate:
|
| type: object
|
| properties:
|
| phoneNumber:
|
| $ref: "#/components/schemas/PhoneNumber"
|
| CreateCheckDeviceSwap:
|
| type: object
|
| properties:
|
| phoneNumber:
|
| $ref: "#/components/schemas/PhoneNumber"
|
| maxAge:
|
| type: integer
|
| example: 240
|
| description: |
|
| Period in hours to be checked for device swap.
|
| format: int32
|
| minimum: 1
|
| maximum: 2400
|
| default: 240
|
| PhoneNumber:
|
| type: string
|
| pattern: '^\+[1-9][0-9]{4,14}$'
|
| example: '+34666111333'
|
| description: 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 '+'.
|
| CheckDeviceSwapInfo:
|
| type: object
|
| required:
|
| - swapped
|
| properties:
|
| swapped:
|
| type: boolean
|
| description: Indicates whether the device has been swapped during the period within the provided age.
|
| ErrorInfo:
|
| type: object
|
| required:
|
| - status
|
| - code
|
| - message
|
| properties:
|
| message:
|
| type: string
|
| description: A human-readable description of what the event represents
|
| status:
|
| type: integer
|
| description: HTTP response status code
|
| code:
|
| type: string
|
| description: A human-readable code to describe the error
|
| responses:
|
| Generic400:
|
| description: Bad Request
|
| headers:
|
| x-correlator:
|
| $ref: "#/components/headers/x-correlator"
|
| content:
|
| application/json:
|
| schema:
|
| allOf:
|
| - $ref: "#/components/schemas/ErrorInfo"
|
| - type: object
|
| properties:
|
| status:
|
| enum:
|
| - 400
|
| code:
|
| enum:
|
| - INVALID_ARGUMENT
|
| examples:
|
| GENERIC_400_INVALID_ARGUMENT:
|
| description: Invalid Argument. Generic Syntax Exception
|
| value:
|
| status: 400
|
| code: INVALID_ARGUMENT
|
| message: Client specified an invalid argument, request body or query param.
|
| Generic400Check:
|
| description: Bad Request
|
| headers:
|
| x-correlator:
|
| $ref: "#/components/headers/x-correlator"
|
| content:
|
| application/json:
|
| schema:
|
| allOf:
|
| - $ref: "#/components/schemas/ErrorInfo"
|
| - type: object
|
| properties:
|
| status:
|
| enum:
|
| - 400
|
| code:
|
| enum:
|
| - INVALID_ARGUMENT
|
| - OUT_OF_RANGE
|
| examples:
|
| GENERIC_400_INVALID_ARGUMENT:
|
| description: Invalid Argument. Generic Syntax Exception
|
| value:
|
| status: 400
|
| code: INVALID_ARGUMENT
|
| message: Client specified an invalid argument, request body or query param.
|
| GENERIC_400_OUT_OF_RANGE:
|
| description: Out of Range. Specific Syntax Exception used when a given field has a pre-defined range or a invalid filter criteria combination is requested
|
| value:
|
| status: 400
|
| code: OUT_OF_RANGE
|
| message: Client specified an invalid range.
|
| Generic401:
|
| description: Unauthorized
|
| headers:
|
| x-correlator:
|
| $ref: "#/components/headers/x-correlator"
|
| content:
|
| application/json:
|
| schema:
|
| allOf:
|
| - $ref: "#/components/schemas/ErrorInfo"
|
| - type: object
|
| properties:
|
| status:
|
| enum:
|
| - 401
|
| code:
|
| enum:
|
| - UNAUTHENTICATED
|
| examples:
|
| GENERIC_401_UNAUTHENTICATED:
|
| description: Request cannot be authenticated
|
| value:
|
| status: 401
|
| code: UNAUTHENTICATED
|
| message: Request not authenticated due to missing, invalid, or expired credentials.
|
| Generic403:
|
| description: Forbidden
|
| headers:
|
| x-correlator:
|
| $ref: "#/components/headers/x-correlator"
|
| content:
|
| application/json:
|
| schema:
|
| allOf:
|
| - $ref: "#/components/schemas/ErrorInfo"
|
| - type: object
|
| properties:
|
| status:
|
| enum:
|
| - 403
|
| code:
|
| enum:
|
| - PERMISSION_DENIED
|
| examples:
|
| GENERIC_403_PERMISSION_DENIED:
|
| description: Permission denied. OAuth2 token access does not have the required scope or when the user fails operational security
|
| value:
|
| status: 403
|
| code: PERMISSION_DENIED
|
| message: Client does not have sufficient permissions to perform this action.
|
| Generic404:
|
| description: Not found
|
| headers:
|
| x-correlator:
|
| $ref: "#/components/headers/x-correlator"
|
| content:
|
| application/json:
|
| schema:
|
| allOf:
|
| - $ref: "#/components/schemas/ErrorInfo"
|
| - type: object
|
| properties:
|
| status:
|
| enum:
|
| - 404
|
| code:
|
| enum:
|
| - NOT_FOUND
|
| - IDENTIFIER_NOT_FOUND
|
| examples:
|
| GENERIC_404_NOT_FOUND:
|
| description: Resource is not found
|
| value:
|
| status: 404
|
| code: NOT_FOUND
|
| message: The specified resource is not found.
|
| GENERIC_404_IDENTIFIER_NOT_FOUND:
|
| description: Some identifier cannot be matched to a device
|
| value:
|
| status: 404
|
| code: IDENTIFIER_NOT_FOUND
|
| message: Device identifier not found.
|
| Generic422:
|
| description: Unprocessable Content
|
| headers:
|
| x-correlator:
|
| $ref: "#/components/headers/x-correlator"
|
| content:
|
| application/json:
|
| schema:
|
| allOf:
|
| - $ref: "#/components/schemas/ErrorInfo"
|
| - type: object
|
| properties:
|
| status:
|
| enum:
|
| - 422
|
| code:
|
| enum:
|
| - SERVICE_NOT_APPLICABLE
|
| - MISSING_IDENTIFIER
|
| - UNNECESSARY_IDENTIFIER
|
| examples:
|
| GENERIC_422_SERVICE_NOT_APPLICABLE:
|
| description: Service not applicable for the provided identifier
|
| value:
|
| status: 422
|
| code: SERVICE_NOT_APPLICABLE
|
| message: The service is not available for the provided identifier.
|
| GENERIC_422_MISSING_IDENTIFIER:
|
| description: phone number is not included in the request (in case of 2-legged) or the phone number identification cannot be derived from access token (in 3-legged)
|
| value:
|
| status: 422
|
| code: MISSING_IDENTIFIER
|
| message: The device cannot be identified.
|
| GENERIC_422_UNNECESSARY_IDENTIFIER:
|
| description: An explicit identifier is provided when a device or phone number has already been identified from the access token
|
| value:
|
| status: 422
|
| code: UNNECESSARY_IDENTIFIER
|
| message: The device is already identified by the access token.
|
| Generic429:
|
| description: Too Many Requests
|
| headers:
|
| x-correlator:
|
| $ref: "#/components/headers/x-correlator"
|
| content:
|
| application/json:
|
| schema:
|
| allOf:
|
| - $ref: "#/components/schemas/ErrorInfo"
|
| - type: object
|
| properties:
|
| status:
|
| enum:
|
| - 429
|
| code:
|
| enum:
|
| - QUOTA_EXCEEDED
|
| - TOO_MANY_REQUESTS
|
| examples:
|
| GENERIC_429_QUOTA_EXCEEDED:
|
| description: Request is rejected due to exceeding a business quota limit
|
| value:
|
| status: 429
|
| code: QUOTA_EXCEEDED
|
| message: Rejected due to exceeding a business quota limit.
|
| GENERIC_429_TOO_MANY_REQUESTS:
|
| description: API Server request limit is overpassed
|
| value:
|
| status: 429
|
| code: TOO_MANY_REQUESTS
|
| message: Rejected due to request rate limit overpassed.
|
| examples:
|
| RETRIEVE_DATE:
|
| summary: Lastest Device swap date is send back
|
| value:
|
| latestDeviceChange: 2024-09-18T07:37:53.471829447Z
|
| RETRIEVE_MONITORED_NULL:
|
| summary: Only null value is retrieved
|
| value:
|
| latestDeviceChange: null
|
| RETRIEVE_MONITORED_PERIOD:
|
| summary: null is send back for the date but a monitoredPeriod is provided
|
| value:
|
| latestDeviceChange: null
|
| monitoredPeriod: 120
|
| CHECK_2LEGS:
|
| summary: Check request without 3-legged access tokens
|
| value:
|
| phoneNumber: "+346661113334"
|
| maxAge: 120
|
| CHECK_3LEGS:
|
| summary: Check request with 3-legged access tokens
|
| value:
|
| maxAge: 120
|
| RETRIEVE_2LEGS:
|
| summary: Retrieve request without 3-legged access tokens
|
| value:
|
| phoneNumber: "+346661113334"
|
| RETRIEVE_3LEGS:
|
| summary: Retrieve request with 3-legged access tokens
|
| value:
|
| {}
|
|
|
