openapi: 3.0.3 info: title: Call Forwarding Signal Age Verification Match API description: '# Overview The Call Forwarding Signal API provides the API Consumer with information about the status of the Call Forwarding Service on a specific phone number. The main scope of the Call Forwarding Signal API is "anti Fraud" to avoid fraudsters to use the Call Forwarding Service to carry on a scam. Other use cases are anyway supported by the Call Forwarding Signal API that also provides additional endpoints to detect the general Call Forwarding Service settings. # Introduction The Call Forwarding Service is provided by the Network to a phone number. This service redirects the incoming call to that phone number to an alternative destination such as another phone number or a voice mail system. There are two main types of call forwarding settings: unconditional and conditional. The Call Forwarding Signal API can be invoked to detect if the unconditional call forwarding service is active. The Call Forwarding Signal API can also be invoked to get the general status of the Call Forwarding Service (inactive, conditional, unconditional). If conditional call forwarding is active, the different type of settings are returned (''conditional_busy'', ''conditional_not_reachable'', ''conditional_no_answer''). **Example use cases:** [**Bank Frauds**](https://github.com/camaraproject/CallForwardingSignal/discussions/3#discussioncomment-8694420) [**Alert Interception**](https://github.com/camaraproject/CallForwardingSignal/discussions/3#discussioncomment-8701847) [**Call Forwarding Verification**](https://github.com/camaraproject/CallForwarding\Signal/discussions/3#discussioncomment-8915595) # Quick Start The Call Forwarding Signal API is a REST API based on the CreateCallForwardingSignal resource. This resource can be used, by the API Consumer, to specify the phone number on which the Call Forwarding Service status must be verified, in case of two-legged authentication. If three-legged authentication is used the phone number is instead detected, by the API Producer, from the access token. Before starting to use the Call Forwarding API, the developer needs to know about the below specified details: **phoneNumber** This is the end user phone number. The Call Forwarding Signal API verifies if a call forwarding service is active on this phone number. Note: this parameter must be must be provided/valued only in case of two-legged authentication. In case of three-legged authentication the phone number is retrieved by the access token. **CreateCallForwardingSignal** This is the resource the API Consumer uses to define the phone number to be verified about the status of the Network Call Forwarding service. **UnconditionalCallForwardingSignal** This is the resource the API Consumer gets back, containing the information about the Unconditional Call Forwarding Service status for the given phone number (PhoneNumber). **CallForwardingSignal** This is the resource the API Consumer gets back, containing the information about the general status of the Network Call Forwarding service for the specified phone number. The Call Forwarding Signal API provides two endpoints fulfilling the following intents: - **unconditional-call-forwardings**: Is the unconditional call fwd service active on a specific phone number? - **call-forwardings**: Which is the status of the call forwarding for a specific phone number? # API Documentation ## Details The Call Forwarding Signal API is invoked by an API Consumer after the Consent Management flow. The API Consumer can request the API Producer for the status of the Unconditional Call Forwarding service using the unconditional-call-forwardings POST method. A boolean, with the information about the activation status of the call forwarding service, will be provided back via the UnconditionalCallForwardingSignal resource. The API Consumer can also request the API Producer for the generic status of the Call Forwarding service using the call-forwardings POST method. An array of strings with the information of the type of active call forwarding services will be provided back via the CallForwardingSignal resource. # 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. # 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 as follows: - When the API is invoked using a two-legged access token, the subject will be identified from the optional `phoneNumber` object field, which therefore MUST be provided. - When a three-legged access token is used however, this optional identifier MUST NOT be provided, as the subject 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 subject cannot be identified from the access token and the optional `phoneNumber` object field is not included in the request, then the server will return an error with the `422 MISSING_IDENTIFIER` error code. - If the subject can be identified from the access token and the optional `phoneNumber` object field 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. # Additional CAMARA error responses 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. # FAQ''s (FAQs will be added in a later version of the documentation) ' version: wip license: name: Apache 2.0 url: https://www.apache.org/licenses/LICENSE-2.0.html x-camara-commonalities: 0.6 servers: - url: '{apiRoot}/call-forwarding-signal/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: Match description: Operations to match a customer identity against the account data bound to their phone number. paths: /match: post: tags: - Match summary: Matching a customer identity by checking a set of attributes related against the account data bound to their phone number. description: "Verify matching of a number of attributes related to a customer identity against the verified data bound to their phone number in the Operator systems. Regardless of whether the `phoneNumber` is explicitly stated in the request body, at least one of the other fields must be provided, otherwise a `HTTP 400 - KNOW_YOUR_CUSTOMER.INVALID_PARAM_COMBINATION` error will be returned.\n\nIn order to proceed with the match check, some Operators may have the requirement to perform an additional level of validation based on the `idDocument` property. This means that, in those cases, the `idDocument` is required and the provided value needs to match the one stored in the Operator system associated with the indicated `phoneNumber`. This validation will be done before proceeding with the match check of the rest of the properties. The following two rules apply only in the cases where the Operator have the requirement to validate the `idDocument`:\n- If no `idDocument` is provided, then a `HTTP 403 - KNOW_YOUR_CUSTOMER.ID_DOCUMENT_REQUIRED` error will be returned.\n- If the provided `idDocument` does not match the one stored in the Operator systems, then a `HTTP 403 - KNOW_YOUR_CUSTOMER.ID_DOCUMENT_MISMATCH` error will be returned.\n\nThe API will return the result of the matching process for each requested attribute. This means that the response will **only** contain the attributes for which validation has been requested. Possible values are:\n - **true**: the attribute provided matches with the one in the Operator systems.\n - **false**: the attribute provided does not match with the one in the Operator systems.\n - **not_available**: the attribute is not available to validate." operationId: KYC_Match security: - openId: - kyc-match:match parameters: - $ref: '#/components/parameters/x-correlator' requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/KYC_MatchRequestBody' examples: Two-Legged and Three-leg Access Token Example: value: phoneNumber: '+34629255833' idDocument: 66666666q name: Federica Sanchez Arjona givenName: Federica familyName: Sanchez Arjona nameKanaHankaku: federica nameKanaZenkaku: Ｆｅｄｅｒｉｃａ middleNames: Sanchez familyNameAtBirth: YYYY address: Tokyo-to Chiyoda-ku Iidabashi 3-10-10 streetName: Nicolas Salmeron streetNumber: '4' postalCode: '1028460' region: Tokyo locality: ZZZZ country: JP houseNumberExtension: VVVV birthdate: '1978-08-22' email: abc@example.com gender: OTHER Three-Legged Without Phone Number Example: value: idDocument: 66666666q name: Federica Sanchez Arjona givenName: Federica familyName: Sanchez Arjona nameKanaHankaku: federica nameKanaZenkaku: Ｆｅｄｅｒｉｃａ middleNames: Sanchez familyNameAtBirth: YYYY address: Tokyo-to Chiyoda-ku Iidabashi 3-10-10 streetName: Nicolas Salmeron streetNumber: '4' postalCode: '1028460' region: Tokyo locality: ZZZZ country: JP houseNumberExtension: VVVV birthdate: '1978-08-22' email: abc@example.com gender: OTHER responses: '200': description: OK headers: x-correlator: $ref: '#/components/headers/x-correlator' content: application/json: schema: $ref: '#/components/schemas/KYC_MatchResponse' examples: KYC_Match200Example: value: idDocumentMatch: 'true' nameMatch: 'true' givenNameMatch: not_available familyNameMatch: not_available nameKanaHankakuMatch: 'true' nameKanaZenkakuMatch: 'false' middleNamesMatch: 'true' familyNameAtBirthMatch: 'false' familyNameAtBirthMatchScore: 90 addressMatch: 'true' streetNameMatch: 'true' streetNumberMatch: 'true' postalCodeMatch: 'true' regionMatch: 'true' localityMatch: not_available countryMatch: 'true' houseNumberExtensionMatch: not_available birthdateMatch: 'false' emailMatch: 'false' emailMatchScore: 87 genderMatch: 'false' '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' components: responses: 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 examples: GENERIC_422_SERVICE_NOT_APPLICABLE: description: Service is not applicable for the provided phone number value: status: 422 code: SERVICE_NOT_APPLICABLE message: The service is not applicable for the provided phone number GENERIC_422_MISSING_IDENTIFIER: description: No phone number has been provided either explicitly or associated with the access token value: status: 422 code: MISSING_IDENTIFIER message: No phone number has been provided 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 - AUTHENTICATION_REQUIRED 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. GENERIC_401_AUTHENTICATION_REQUIRED: description: New authentication is needed, authentication is no longer valid value: status: 401 code: AUTHENTICATION_REQUIRED message: New authentication is required. 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 - INVALID_TOKEN_CONTEXT - KNOW_YOUR_CUSTOMER.ID_DOCUMENT_REQUIRED - KNOW_YOUR_CUSTOMER.ID_DOCUMENT_MISMATCH 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. GENERIC_403_INVALID_TOKEN_CONTEXT: description: Reflect some inconsistency between information in some field of the API and the related OAuth2 Token value: status: 403 code: INVALID_TOKEN_CONTEXT message: phoneNumber is not consistent with access token. KNOW_YOUR_CUSTOMER.ID_DOCUMENT_REQUIRED: description: The idDocument is required by the implementation value: status: 403 code: KNOW_YOUR_CUSTOMER.ID_DOCUMENT_REQUIRED message: The idDocument is required to perform the properties validation KNOW_YOUR_CUSTOMER.ID_DOCUMENT_MISMATCH: description: idDocument mismatch value: status: 403 code: KNOW_YOUR_CUSTOMER.ID_DOCUMENT_MISMATCH message: The idDocument needs to match the one associated with the provided phoneNumber 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 - KNOW_YOUR_CUSTOMER.INVALID_PARAM_COMBINATION 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. KNOW_YOUR_CUSTOMER.INVALID_PARAM_COMBINATION: description: Indicated param combination is invalid value: status: 400 code: KNOW_YOUR_CUSTOMER.INVALID_PARAM_COMBINATION message: Indicated parameter combination is invalid 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 GENERIC_404_IDENTIFIER_NOT_FOUND: description: The phone number is not associated with a CSP customer account value: status: 404 code: IDENTIFIER_NOT_FOUND message: The phone number provided is not associated with a customer account schemas: KYC_MatchResponse: type: object properties: idDocumentMatch: allOf: - $ref: '#/components/schemas/MatchResult' - description: Indicates whether Id number associated to the ID document of the customer matches with the one on the Operator's system. nameMatch: allOf: - $ref: '#/components/schemas/MatchResult' - description: Indicates whether the complete name of the customer matches with the one on the Operator's system. nameMatchScore: $ref: '#/components/schemas/MatchScoreResult' givenNameMatch: allOf: - $ref: '#/components/schemas/MatchResult' - description: Indicates whether First name/given name of the customer matches with the one on the Operator's system. givenNameMatchScore: $ref: '#/components/schemas/MatchScoreResult' familyNameMatch: allOf: - $ref: '#/components/schemas/MatchResult' - description: Indicates whether last name/ family name/ surname of the customer matches with the one on the Operator's system. familyNameMatchScore: $ref: '#/components/schemas/MatchScoreResult' nameKanaHankakuMatch: allOf: - $ref: '#/components/schemas/MatchResult' - description: 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: $ref: '#/components/schemas/MatchScoreResult' nameKanaZenkakuMatch: allOf: - $ref: '#/components/schemas/MatchResult' - description: 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: $ref: '#/components/schemas/MatchScoreResult' middleNamesMatch: allOf: - $ref: '#/components/schemas/MatchResult' - description: Indicates whether the middle names of the customer matches with the one on the Operator's system. middleNamesMatchScore: $ref: '#/components/schemas/MatchScoreResult' familyNameAtBirthMatch: allOf: - $ref: '#/components/schemas/MatchResult' - description: Indicates whether the Family Name At Birth of the customer matches with the one on the Operator's system. familyNameAtBirthMatchScore: $ref: '#/components/schemas/MatchScoreResult' addressMatch: allOf: - $ref: '#/components/schemas/MatchResult' - description: Indicates whether complete address of the customer matches with the one on the Operator's system. addressMatchScore: $ref: '#/components/schemas/MatchScoreResult' streetNameMatch: allOf: - $ref: '#/components/schemas/MatchResult' - description: Indicates whether the street name of the customer matches with the one on the Operator's system. streetNameMatchScore: $ref: '#/components/schemas/MatchScoreResult' streetNumberMatch: allOf: - $ref: '#/components/schemas/MatchResult' - description: Indicates whether the street number of the customer matches with the one on the Operator's system. streetNumberMatchScore: $ref: '#/components/schemas/MatchScoreResult' postalCodeMatch: allOf: - $ref: '#/components/schemas/MatchResult' - description: Indicates whether the postal code / zip code of the customer matches with the one on the Operator's system. regionMatch: allOf: - $ref: '#/components/schemas/MatchResult' - description: Indicates whether the region of the customer's address matches with the one on the Operator's system. regionMatchScore: $ref: '#/components/schemas/MatchScoreResult' localityMatch: allOf: - $ref: '#/components/schemas/MatchResult' - description: Indicates whether the locality of the customer's address matches with the one on the Operator's system. localityMatchScore: $ref: '#/components/schemas/MatchScoreResult' countryMatch: allOf: - $ref: '#/components/schemas/MatchResult' - description: Indicates whether the country of the customer's address matches with the one on the Operator's system. houseNumberExtensionMatch: allOf: - $ref: '#/components/schemas/MatchResult' - description: Indicates whether the house number extension of the customer's address with the one on the Operator's system. birthdateMatch: allOf: - $ref: '#/components/schemas/MatchResult' - description: Indicates whether the birthdate of the customer matches with the one on the Operator's system. emailMatch: allOf: - $ref: '#/components/schemas/MatchResult' - description: Indicates whether the email address of the customer matches with the one on the Operator's system. emailMatchScore: $ref: '#/components/schemas/MatchScoreResult' genderMatch: allOf: - $ref: '#/components/schemas/MatchResult' - description: Indicates whether the gender of the customer matches with the one on the Operator's system. ErrorInfo: type: object required: - status - code - message properties: status: type: integer description: HTTP response status code code: type: string description: Code given to this error message: type: string description: Detailed error description MatchScoreResult: type: integer description: 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`. minimum: 0 maximum: 100 MatchResult: type: string enum: - 'true' - 'false' - not_available KYC_MatchRequestBody: type: object description: Payload to validate the customer data. properties: phoneNumber: type: string 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 '+'. pattern: ^\+[1-9][0-9]{4,14}$ example: '+123456789' idDocument: type: string description: Id number associated to the official identity document in the country. It may contain alphanumeric characters. name: type: string description: 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: type: string description: First/given name or compound first/given name of the customer. familyName: type: string description: Last name, family name, or surname of the customer. nameKanaHankaku: type: string description: Complete name of the customer in Hankaku-Kana format (reading of name) for Japan. nameKanaZenkaku: type: string description: Complete name of the customer in Zenkaku-Kana format (reading of name) for Japan. middleNames: type: string description: Middle name/s of the customer. familyNameAtBirth: type: string description: Last/family/sur- name at birth of the customer. address: type: string description: 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: type: string description: Name of the street of the customer's address. It should not include the type of the street. streetNumber: type: string description: The street number of the customer's address. Number identifying a specific property on the 'streetName'. postalCode: type: string description: Zip code or postal code region: type: string description: Region/prefecture of the customer's address locality: type: string description: Locality of the customer's address country: type: string description: Country of the customer's address. Format ISO 3166-1 alpha-2 houseNumberExtension: type: string description: Specific identifier of the house needed depending on the property type. For example, number of apartment in an apartment building. birthdate: type: string format: date description: The birthdate of the customer, in RFC 3339 / ISO 8601 calendar date format (YYYY-MM-DD). email: type: string format: email description: Email address of the customer in the RFC specified format (local-part@domain). gender: type: string description: Gender of the customer (Male/Female/Other). enum: - MALE - FEMALE - OTHER headers: x-correlator: description: Correlation id for the different services schema: type: string pattern: ^[a-zA-Z0-9-]{0,55}$ parameters: x-correlator: name: x-correlator in: header description: Correlation id for the different services schema: type: string pattern: ^[a-zA-Z0-9-]{0,55}$ example: b4333c46-49c0-4f62-80d7-f0ef930f1c46 securitySchemes: openId: description: to support Consent Management type: openIdConnect openIdConnectUrl: https://example.com/.well-known/openid-configuration externalDocs: description: Product documentation at CAMARA url: https://github.com/camaraproject/CallForwardingSignal