KYC Match - CAMARA Sandbox - Orange lab 0.1 Beta

Getting started

• Disclaimer (sandboxed version)
• Introduction
  • Subscribe to the API
  • API Authentication
  • API Description
    • Summary of resources
    • Summary of methods and URL
    • Summary of request body parameters
      • Request
      • Response
      • Fields description
    • Most frequent errors
• Looking for support ?
• History of document

Disclaimer (sandboxed version)

This CAMARA Sandbox - KYC Match - Orange lab API is a sandboxed version of the production-grade CAMARA - KYC Match API.

It is running in our lab, against a small list of lab-specific mobile devices (see list of phone number available for test below).

This API could be suspended or upgraded any time without any notice.

Introduction

The CAMARA KYC Match API provides a standardized mechanism to customer with the ability to compare the information it (Service Provider, SP) has for a particular user with that on file (and verified) by the 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 user

Subscribe to the API

You get the Authorization header credentials when you register your application on the [Orange Developer Console] (https://developer.orange.com/myapps).

API Authentication

Note: In production environment the KYC Match API will require a 3-Legged OAuth 2.0 flow but as this implementation is provided on Orange Lab, the API works with a 2-Legged OAuth.

To learn more about how Orange Developer handles authentication, please refer to our documentation.

In short, you will use your Orange Developer Authorization header as authorization_header for the Basic authentication with Orange Developer.

curl -X POST \
-H "Authorization: {{ authorization_header }}" \
-d "grant_type=client_credentials" \
https://api.orange.com/oauth/v3/token

In response, you will get an access_token.

{
       "token_type": "Bearer",
       "access_token": "66AeYJF8eJQ...2SjkFg9LB1LePC",
       "expires_in": "3600"
}

Go up

API Description

Summary of resources

This API has one resource match. MatchResult attribute provides in the response information about mobile equipment location check.

Summary of methods and URL

Go up

Summary of request body parameters

In bold parameters currently available in Orange France API

Lab implementation specific:

As KYC Match - CAMARA Sandbox - Orange lab offer implements a 2-Legged authentication, phoneNumber is required in the request body and must belong to the following list and corresponding identities (other will not work).

Note:

• Identities are a pure fake identities generated with a tool.

Example of Body value:

{
    "phoneNumber": "+33699901031",
    "givenName": "Maeva",
    "familyName": "Huart",
    "locality": "Pottiernec",
    "address": "12 impasse Samson",
    "postalCode": "70691",
    "country": "fr",
    "email": "maeva.huart@voila.fr",
    "birthdate": "1978-08-22"
}

Summary of response parameters

In bold parameters currently available in Orange France API

Go up

Request

curl -X POST "https://api.orange.com/camara/orange-lab/kyc-match/v0/match"
-H "Authorization: Bearer {your access token}"
-H "Cache-Control: no-cache"  
-H 'accept: application/json'
-H 'Content-Type: application/json'
-d  {
    "phoneNumber": "+33699901031",
    "givenName": "Maeva",
    "familyName": "Hurt",
    "address": "12 impasse Samson",
    "locality": "Pottrnec",
    "email": "maeva.huart@voila.fr"
}

Response

200 Match successful
Content-Type: application/json

{
    "giventNameMatch": "True",
    "familyNameMatch": "False",
    "familyNameMatchScore": 90.85,
    "addressMatch": "True",
    "localityMatch": "False",
    "localityMatchScore": 95.12,
    "emailMatch": "True"
}

Go up

Fields description

The response contains

• MatchResult attributes valued to true when user's information matches exactely with information held by the MNO, false when it doesn't match exactly or not_available when the MNO doesn't hold user's information.
• MatchScore, a numerical value that quantifies the similarity between two pieces of text based on the words they contain for some MatchResult attributes in case of value is equal to false.

Most frequent errors

If invalid input are provided in particular for the device identifier a 400 error is triggered.

HTTP/1.1 400 Invalid input
Content-Type: application/json
{
  "code": "INVALID_ARGUMENT",
  "status": 400,
  "message": "Invalid input"
}

If the network back end is not able to localize the equipment, a 404 error is sent.

HTTP/1.1 404 Not Found
Content-Type: application/json
{
  "status": 404,
  "code": "NOT_FOUND",
  "message": "Unknown Location"
}

If the localisation service is not up and running, a 503 error is sent.

HTTP/1.1 503 Service unavailable
Content-Type: application/json
{
  "code": "UNAVAILABLE",
  "status": 503,
  "message": "Service unavailable"
}

There are some cases where your client application will no longer gain access to API resources, and get an error back.

Please check the following points:

• Here, you attempt to use an expired or revoked access_token and you get an invalid token error. You will have to request a new access_token. As an example:

HTTP/1.1 401 Unauthorized
Content-Type: application/json
{
  "code": "UNAUTHENTICATED",
  "status": 401,
  "message": "Authorization failed: ..."
}

• Here, you removed your subscription to the API so that the capability to generate an access_token is not allowed anymore. As an example:

HTTP/1.1 403 Forbidden
Content-Type: application/json
{
  "code": "PERMISSION_DENIED",
  "status": 403,
  "message": "Operation not allowed: ..."
}

Looking for support ?

Facing technical issue when using this API ? please contact us

Go up

History of document

Go up