Orange Business Match API

openapi: 3.2.0
info:
  title: Know Your Customer Match API
  description: This API provides the customer with the ability to compare the information it (Service Provider, SP) has for a particular mobile phone user with that on file (and verified) by the mobile phone user's Operator in their own KYC records, in order for the SP to confirm the accuracy of the information and provide a specific service to the mobile phone user.
  version: wip
  x-camara-commonalities: 0.6
  license:
    name: Apache 2.0
    url: https://www.apache.org/licenses/LICENSE-2.0.html
servers:
- url: '{apiRoot}/kyc-match/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…
      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.


        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, which is equal to a `match_score` of 100.

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

        - **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
                  idDocumentType: passport
                  idDocumentExpiryDate: '2027-07-12'
                  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
                  cityOfBirth: Madrid
                  countryOfBirth: ES
                  nationality: ES
              Three-Legged Without Phone Number Example:
                value:
                  idDocument: 66666666q
                  idDocumentType: passport
                  idDocumentExpiryDate: '2027-07-12'
                  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
                  cityOfBirth: Madrid
                  countryOfBirth: ES
                  nationality: ES
      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'
                    idDocumentTypeMatch: 'true'
                    idDocumentExpiryDateMatch: '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'
                    cityOfBirthMatch: 'false'
                    cityOfBirthMatchScore: 86
                    countryOfBirthMatch: 'true'
                    nationalityMatch: 'true'
        '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:
    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
    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
          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.
    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
          examples:
            GENERIC_401_UNAUTHENTICATED:
              description: Request cannot be authenticated and a new authentication is required
              value:
                status: 401
                code: UNAUTHENTICATED
                message: Request not authenticated due to missing, invalid, or expired credentials. A new authentication is required.
    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: 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:
    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`.

        A perfect match with a score of 100 is indicated by `match` being ''true'' and no `matchScore` is returned in this case.

        '
      minimum: 0
      maximum: 99
    MatchResult:
      type: string
      description: 'true -  the attribute provided matches with the one in the Operator systems, which is equal to a `match_score` of 100.

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

        not_available - the attribute is not available to validate.

        '
      enum:
      - 'true'
      - 'false'
      - not_available
    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
    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.
        idDocumentTypeMatch:
          allOf:
          - $ref: '#/components/schemas/MatchResult'
          - description: Indicates whether document type associated to the ID document of the customer matches with the one on the Operator's system.
        idDocumentExpiryDateMatch:
          allOf:
          - $ref: '#/components/schemas/MatchResult'
          - description: Indicates whether document expiration date 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.
        cityOfBirthMatch:
          allOf:
          - $ref: '#/components/schemas/MatchResult'
          - description: Indicates whether the city at birth of the customer matches with the one on the Operator's system
        cityOfBirthMatchScore:
          $ref: '#/components/schemas/MatchScoreResult'
        countryOfBirthMatch:
          allOf:
          - $ref: '#/components/schemas/MatchResult'
          - description: Indicates whether the country at birth of the customer matches with the one on the Operator's system
        nationalityMatch:
          allOf:
          - $ref: '#/components/schemas/MatchResult'
          - description: Indicates whether the nationality of the customer matches with the one on the Operator's system
    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.
        idDocumentType:
          type: string
          enum:
          - passport
          - national_id_card
          - residence_permit
          - diplomatic_id
          - driver_licence
          - social_security_id
          - other
          description: Type of the official identity document provided.
        idDocumentExpiryDate:
          type: string
          format: date
          description: Expiration date of the identity document (ISO 8601).
        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
        cityOfBirth:
          type: string
          description: City where the customer was born.
        countryOfBirth:
          type: string
          description: Country where the customer was born. Format ISO 3166-1 alpha-2.
        nationality:
          type: string
          description: ISO 3166-1 alpha-2 code of the customer’s nationality. In the case a customer has more than one nationality, it is supposed to be the nationality related to the ID document provided in the match request.
    XCorrelator:
      type: string
      pattern: ^[a-zA-Z0-9-_:;.\/<>{}]{0,256}$
      example: b4333c46-49c0-4f62-80d7-f0ef930f1c46
  headers:
    x-correlator:
      description: Correlation id for the different services
      required: false
      schema:
        $ref: '#/components/schemas/XCorrelator'
  parameters:
    x-correlator:
      name: x-correlator
      in: header
      description: Correlation id for the different services
      required: false
      schema:
        $ref: '#/components/schemas/XCorrelator'
  securitySchemes:
    openId:
      type: openIdConnect
      openIdConnectUrl: https://example.com/.well-known/openid-configuration
externalDocs:
  description: Product documentation at CAMARA
  url: https://github.com/camaraproject/KnowYourCustomerMatch