Skip to main content
POST
/
v1
/
reports
/
{id}
/
identity
/
match
Name match
curl --request POST \
  --url https://api.swippee.com/v1/reports/{id}/identity/match \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "Ram Bahadur Thapa"
}
'
{
  "match_score": 100,
  "statement_name": "<string>",
  "reasons": [
    "<string>"
  ]
}

Authorizations

Authorization
string
header
required

Your API key from the dashboard, sent as Authorization: Bearer swippee_sk_live_....

Path Parameters

id
string
required

Body

application/json
name
string
required
Example:

"Ram Bahadur Thapa"

Response

Match result

match_score
integer
Example:

100

result
enum<string>
Available options:
match,
partial_match,
no_match,
no_data
statement_name
string | null
reasons
string[]