Nokia KYC Match v0.3 API

openapi: 3.2.0
info:
  title: Nokia Corp KYC Match v0.3 API
  version: 1.0.0
  termsOfService: https://developer.networkascode.nokia.io/legal/terms-of-service
  x-refined-note:
  - x-badges differs across the merged source definitions and was not carried
  - x-camara-commonalities differs across the merged source definitions and was not carried
  - x-category differs across the merged source definitions and was not carried
  - x-collections differs across the merged source definitions and was not carried
  - x-long-description differs across the merged source definitions and was not carried
  - x-public differs across the merged source definitions and was not carried
  - x-thumbnail differs across the merged source definitions and was not carried
  - x-version-lifecycle differs across the merged source definitions and was not carried
  - x-website differs across the merged source definitions and was not carried
  description: 'Operations tagged KYC Match v0.3 across 3 of this provider''s published API definitions: Single-NaC-API-OAS.yaml, rapid-spec-oas.json, nokia-corp-network-as-code-openapi.yml. Each path carries the servers of the definition it was published in.'
servers:
- url: '{apiRoot}/geofencing-subscriptions/v0.3'
  variables:
    apiRoot:
      default: http://localhost:9091
      description: API root
- url: '{apiRoot}/geofencing-subscriptions/v0.4'
  variables:
    apiRoot:
      default: http://localhost:9091
      description: API root
- url: https://network-as-code.p-eu.rapidapi.com
tags:
- name: KYC Match v0.3
paths:
  /passthrough/camara/v1/kyc-match/kyc-match/v0.3/match:
    post:
      tags:
      - KYC Match v0.3
      summary: Matching a customer identity by checking a set of attributes related against…
      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.


        In 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`:

        - If no `idDocument` is provided, then a `HTTP 403 - KNOW_YOUR_CUSTOMER.ID_DOCUMENT_REQUIRED` error will be returned.

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


        The 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:


        - **true**: the attribute provided matches with the one in the Operator systems.

        - **false**: the attribute provided does not match with the one in the Operator systems.

        - **not_available**: the attribute is not available to validate.'
      operationId: verifyKYCMatch
      security:
      - openId:
        - kyc-match:match
      parameters:
      - $ref: '#/components/parameters/x-correlator-KYC-M-V0'
      - in: header
        name: authorization
        required: false
        description: authorization header for token
        schema:
          type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/KYC_MatchRequestBody-KYC-M-V0'
            examples:
              KYC_MATCH:
                value:
                  phoneNumber: '+99999991000'
                  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
              KYC_MATCH_3_LEGGED_FLOW:
                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-KYC-M-V0'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/KYC_MatchResponse-KYC-M-V0'
              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-KYC-M-V0'
        '401':
          $ref: '#/components/responses/Generic401-KYC-M-V0'
        '403':
          $ref: '#/components/responses/Generic403-KYC-M-V0'
        '404':
          $ref: '#/components/responses/Generic404-KYC-M-V0'
        '422':
          $ref: '#/components/responses/Generic422-KYC-M-V0'
    servers:
    - url: '{apiRoot}/geofencing-subscriptions/v0.3'
      variables:
        apiRoot:
          default: http://localhost:9091
          description: API root
    - url: '{apiRoot}/geofencing-subscriptions/v0.4'
      variables:
        apiRoot:
          default: http://localhost:9091
          description: API root
components:
  parameters:
    x-correlator-KYC-M-V0:
      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
    x-rapidapi-host:
      name: x-rapidapi-host
      in: header
      required: true
      description: The API's Host value as defined in the RapidAPI Hub.
      schema:
        type: string
        example: network-as-code.p-eu.rapidapi.com
  responses:
    Generic403-KYC-M-V0:
      description: Forbidden
      headers:
        x-correlator:
          $ref: '#/components/headers/x-correlator-KYC-M-V0'
      content:
        application/json:
          schema:
            allOf:
            - $ref: '#/components/schemas/ErrorInfo-KYC-M-V0'
            - 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
    Generic422-KYC-M-V0:
      description: Unprocessable Content
      headers:
        x-correlator:
          $ref: '#/components/headers/x-correlator-KYC-M-V0'
      content:
        application/json:
          schema:
            allOf:
            - $ref: '#/components/schemas/ErrorInfo-KYC-M-V0'
            - 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
    Generic400-KYC-M-V0:
      description: Bad Request
      headers:
        x-correlator:
          $ref: '#/components/headers/x-correlator-KYC-M-V0'
      content:
        application/json:
          schema:
            allOf:
            - $ref: '#/components/schemas/ErrorInfo-KYC-M-V0'
            - 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-KYC-M-V0:
      description: Not found
      headers:
        x-correlator:
          $ref: '#/components/headers/x-correlator-KYC-M-V0'
      content:
        application/json:
          schema:
            allOf:
            - $ref: '#/components/schemas/ErrorInfo-KYC-M-V0'
            - 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
    Generic401-KYC-M-V0:
      description: Unauthorized
      headers:
        x-correlator:
          $ref: '#/components/headers/x-correlator-KYC-M-V0'
      content:
        application/json:
          schema:
            allOf:
            - $ref: '#/components/schemas/ErrorInfo-KYC-M-V0'
            - 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.
  schemas:
    MatchResult-KYC-M-V0:
      type: string
      enum:
      - 'true'
      - 'false'
      - not_available
    ErrorInfo-KYC-M-V0:
      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
    KYC_MatchResponse-KYC-M-V0:
      type: object
      properties:
        idDocumentMatch:
          allOf:
          - $ref: '#/components/schemas/MatchResult-KYC-M-V0'
          - 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-KYC-M-V0'
          - description: Indicates whether the complete name of the customer matches with the one on the Operator's system.
        nameMatchScore:
          $ref: '#/components/schemas/MatchScoreResult-KYC-M-V0'
        givenNameMatch:
          allOf:
          - $ref: '#/components/schemas/MatchResult-KYC-M-V0'
          - description: Indicates whether First name/given name of the customer matches with the one on the Operator's system.
        givenNameMatchScore:
          $ref: '#/components/schemas/MatchScoreResult-KYC-M-V0'
        familyNameMatch:
          allOf:
          - $ref: '#/components/schemas/MatchResult-KYC-M-V0'
          - 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-KYC-M-V0'
        nameKanaHankakuMatch:
          allOf:
          - $ref: '#/components/schemas/MatchResult-KYC-M-V0'
          - 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-KYC-M-V0'
        nameKanaZenkakuMatch:
          allOf:
          - $ref: '#/components/schemas/MatchResult-KYC-M-V0'
          - 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-KYC-M-V0'
        middleNamesMatch:
          allOf:
          - $ref: '#/components/schemas/MatchResult-KYC-M-V0'
          - description: Indicates whether the middle names of the customer matches with the one on the Operator's system.
        middleNamesMatchScore:
          $ref: '#/components/schemas/MatchScoreResult-KYC-M-V0'
        familyNameAtBirthMatch:
          allOf:
          - $ref: '#/components/schemas/MatchResult-KYC-M-V0'
          - 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-KYC-M-V0'
        addressMatch:
          allOf:
          - $ref: '#/components/schemas/MatchResult-KYC-M-V0'
          - description: Indicates whether complete address of the customer matches with the one on the Operator's system.
        addressMatchScore:
          $ref: '#/components/schemas/MatchScoreResult-KYC-M-V0'
        streetNameMatch:
          allOf:
          - $ref: '#/components/schemas/MatchResult-KYC-M-V0'
          - description: Indicates whether the street name of the customer matches with the one on the Operator's system.
        streetNameMatchScore:
          $ref: '#/components/schemas/MatchScoreResult-KYC-M-V0'
        streetNumberMatch:
          allOf:
          - $ref: '#/components/schemas/MatchResult-KYC-M-V0'
          - description: Indicates whether the street number of the customer matches with the one on the Operator's system.
        streetNumberMatchScore:
          $ref: '#/components/schemas/MatchScoreResult-KYC-M-V0'
        postalCodeMatch:
          allOf:
          - $ref: '#/components/schemas/MatchResult-KYC-M-V0'
          - 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-KYC-M-V0'
          - description: Indicates whether the region of the customer's address matches with the one on the Operator's system.
        regionMatchScore:
          $ref: '#/components/schemas/MatchScoreResult-KYC-M-V0'
        localityMatch:
          allOf:
          - $ref: '#/components/schemas/MatchResult-KYC-M-V0'
          - description: Indicates whether the locality of the customer's address matches with the one on the Operator's system.
        localityMatchScore:
          $ref: '#/components/schemas/MatchScoreResult-KYC-M-V0'
        countryMatch:
          allOf:
          - $ref: '#/components/schemas/MatchResult-KYC-M-V0'
          - 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-KYC-M-V0'
          - 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-KYC-M-V0'
          - description: Indicates whether the birthdate of the customer matches with the one on the Operator's system.
        emailMatch:
          allOf:
          - $ref: '#/components/schemas/MatchResult-KYC-M-V0'
          - description: Indicates whether the email address of the customer matches with the one on the Operator's system.
        emailMatchScore:
          $ref: '#/components/schemas/MatchScoreResult-KYC-M-V0'
        genderMatch:
          allOf:
          - $ref: '#/components/schemas/MatchResult-KYC-M-V0'
          - description: Indicates whether the gender of the customer matches with the one on the Operator's system.
    KYC_MatchRequestBody-KYC-M-V0:
      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
    MatchScoreResult-KYC-M-V0:
      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
  headers:
    x-correlator-KYC-M-V0:
      description: Correlation id for the different services
      schema:
        type: string
        pattern: ^[a-zA-Z0-9-]{0,55}$
  securitySchemes:
    openId:
      description: OpenID Connect authentication
      type: openIdConnect
      openIdConnectUrl: https://example.com/.well-known/openid-configuration
    ApiKeyAuth:
      type: apiKey
      in: header
      name: x-rapidapi-key
      description: Your RapidAPI key
externalDocs:
  description: Project documentation at Camara
  url: https://github.com/camaraproject/DeviceLocation
x-refined-from:
- Single-NaC-API-OAS.yaml
- rapid-spec-oas.json
- nokia-corp-network-as-code-openapi.yml
x-provenance:
  method: harvested
  publisher: Nokia
  source: https://raw.githubusercontent.com/nokia-steward/network-as-code-sdks/main/openapi/Single-NaC-API-OAS.yaml
  note: split by refine-openapis from the provider's own published document, verified by fetch (openapi/_original/*.fetch.json);
    stamped by stamp-openapi-provenance.py (roadmap#793)