Overview
Additional Information
Overview
Additional Information
Overview
Additional Information
Overview
Additional Information
Match
Match verifies identity attributes linked to a customer’s mobile phone number. This creates a high trust and low friction method for verifying identity online.
With the new version of the Match API, we’re moving from exact matching to a more flexible, score-based matching system using Yaro-Winkler fuzzy logic.
This API follows the CAMARA standard specification.
It can be used to
Completing Know Your Customer (KYC) compliance checks.
New customer enrolment and verification,
Validating user details as part of remote identity checks.
API Information
Version | v0.2.1 |
Protocol | HTTPS |
Sandbox URL | https://api-sandbox.vf-dmp.engineering.vodafone.com |
Live URL | https://api.vf-dmp.engineering.vodafone.com |
Version history | Release date | Status | Description |
|---|---|---|---|
0.2.1 | December 2024 | Live | Match API - CAMARA specification with fuzzy logic. |
Endpoints
Method | Name | Endpoint |
|---|---|---|
POST | JWT Authentication Flow | /ouath2/v2/token |
POST | Authentication Request | /openIDConnectCIBA/v1/bc-authorize |
POST | Token Request | /openIDConnectCIBA/v1/token |
POST | KYC Match | /kyc-match/v0.2/match |
GET | Ping | /kyc-match/v0.2/ping |
How it works
Match your customer's data instantly against first-party Know Your Customer (KYC) attributes held by Vodafone:
Given Name, Family Name, Date of Birth, First line of address, Postal Code.
Similar to a credit check, no user information is shared.
The API checks if the submitted attributes match with the data that hold by Vodafone against the phone number.
The API will respond with
trueorfalseand match score of 0%-99% in case offalse.This service works for Vodafone mobile numbers (MSISDNs) only.
As an example, a new customer is shopping at an online clothing retailer and may wish to pay for their purchases in instalments:
The customer goes to checkout from the website and submits payment for the goods they want to purchase.
The website asks them to register their details for the first time.
The app sends a request to Vodafone's Match API.
The API compares the attributes submitted by the user with the details that Vodafone holds against that user and sends a response for each of the API attributes.
If the details don't match to a certain treshold, further identity checks may be required, so that the retailer can ensure that the user is real.
What's New in the Latest Version?
With the new version of the Match API, we are moving from exact matching to a more flexible, score-based matching system using Yaro-Winkler fuzzy logic. Instead of a binary true/false result, the API now returns a match score from 0 to 99 in case of false. This allows for a nuanced view of matching results, giving the developer more control over what is considered a successful match. The higher the score, the closer the match, and the developer will have the flexibility to interpret these scores in a way that best suits their business needs.
Whit this new model, Vodafone anticipates higher match rates, which will be invaluable for identity verification while reducing false negatives and enhancing customer onboarding experiences.
Run in Postman
To begin using the Vodafone workspace in Postman, please follow the steps below to create a set of credentials that can be used with our sandbox collections:
Register an account on https://developer.vodafone.com and create a sandbox app for the APIs that you are interested in.
Use the Client Key and Secret from your sandbox app to populate the relating variables in the "Sandbox Credentials" environment group in Postman.
These API use a three-legged OAuth flow. A three-legged OAuth process involves three parties: the end-user (or resource owner), the client (the third-party application), and the server (or authorization server).
First call the authorize endpoint to get an authorization code. Your client credentials will be taken from the environment variables.
You need to call the authorize end-point for each Identity API in the CAMARA portfolio as the product scope is set in the request body of the authorize call.
Call the token endpoint to exchange the authorization code for a bearer token that is used in the API resource endpoint.
The last bearer token and trace ID will be stored in collection variables associated with the API solution that you have chosen.
You can use these collections as read-only or create a fork into your own personal workspace to edit the details.
You can access all of Vodafone's sandbox APIs in our Postman workspace by clicking the link below:
What is Postman?
Postman is a popular development and testing tool that is widely used across the API developer community. It offers an easy to use interface for making HTTP requests, testing API responses and collaborating with team members. For more details, see postman.com