API Reference

Overview

The Nametag API contains several parts:

  • Request - get people’s consent to share data with you, to log in to your site, or to execute a transaction. (based on OAuth 2.0)
  • People - fetch and manage the data that people have shared with you.
  • Configuration - manage the configuration of your organization.

Scopes

Scopes are used to describe the information you want people to share with you. In order to request a scope you must first define it in your environment and provide additional parameters, such as what type of data and how long you need the data. This is done separately for each environment you manage in the developer console.

The following scopes are defined:

Scope Type Description
nt:name string The person’s preferred name 1
nt:first_name string The person’s preferred given (first) name 2
nt:last_name string The person’s preferred family (last) name 2
nt:phone string Phone number, in E.164 format, e.g +1 202 555-1212.
nt:email string Verified email address
nt:legal_name string The person’s name from their identity document.
nt:legal_first_name string The given name (first name) from their identity document 2
nt:legal_last_name string The family name (last name) from their identity document 2
nt:birth_date RFC 3339 full-date The person’s date of birth
nt:govtid_details GovtidDetailsValue Details about the person’s identity document
nt:covid_vaccine COVIDVaccineValue Information about their COVID vaccination status
nt:covid_card COVIDVaccineValue Information about their COVID vaccination status, including a URL to the image of the evidence they provided.
nt:age_over_21 boolean true if the person is over 21 years old, otherwise false.
nt:age_over_18 boolean true if the person is over 18 years old, otherwise false.
nt:profile_picture URL A URL to the person’s preferred profile picture. Nametag checks that the image provided is the same person as pictured on their identity document.

Subject

A subject uniquely identifies a person. We recommend that you store this field in your database when identifying a person. (In fact, this may be the only thing you need to store in your database.)

Subjects are stable within an environment. This means that even if someone revokes access to your environment and then re-grants it, or if they delete and re-install the Nametag app, the subject will remain unchanged.

Because each environment is its own privacy domain, different environments will be issued with different subjects for the same person.

Environments

Each user of the Nametag API creates one or more environments which are the basic unit of privacy separation. This means that anything a person shares with an environment is kept private from another. My default you will have one environment called “Live” for your production use and another called “Sandbox” for development, but you can have as many or as few environments as you like.

Organizations

Organizations are the unit of access control for you and your colleagues. Each Organization contains one or more Environments. Each organization has members (your colleagues) and can be assigned to roles (administrator, or read-only access).

Basics

The Nametag API is located at https://nametag.co. All requests must be made via HTTPS. Unless otherwise noted, all requests and responses are JSON-encoded and use the application/json content type.

Authentication

How you authenticate to the Nametag API varies based on the context. The following authentication methods are available:

API Key

API keys are used to manage organizations and environments. Get an API key from the developer console. Each API is scoped to either work for a single environment or across all your environments, depending on your needs.

To use an API key, use HTTP basic authentication with an empty username and the API_KEY as the password, or supply an API_KEY using the token query parameter.

# list all my environments (must use a global API key)
$ curl -u ":API_KEY" https://nametag.co/api/envs
# fetch information about a person (can use either a global API key, or an environment-scoped API key)
$ curl https://nametag.co/people/SUBJECT/nt:name,nt:age_over_21?token=API_KEY

ID Token

An ID token authenticates a particular person, rather than your entire environment. This is returned from the token endpoint. You can use ID tokens to fetch information about a single user only, and you must use the URL /people/me/.... To use an ID token, use HTTP basic authentication with an empty username and the ID_TOKEN as the password.

# get the current user's name
$ curl -u ":ID_TOKEN" https://nametag.co/people/me/nt:name

Response Codes

When a call succeeds the Nametag API responds with HTTP a 2xx status code:

  • 200 Ok - when data is being returned.
  • 204 No Content - when there is no response data.

In the case of errors, the server responds with the following status codes:

  • 400 Bad Request - The request is malformed.
  • 401 Unauthorized - The request lacks the required authentication credentials.
  • 403 Forbidden - The credentials provided do not permit the requested action.
  • 429 Too Many Requests - A rate limit has been exceeded.
  • 500 Internal Server Error - Something went wrong on our end.

Rate limits

Responses from the API contain several headers to provide feedback on our rate limiters. The rate limiter defines a maximum number of requests allowed in a particular time window. The number of requests and the time window may vary according to the particular route and access pattern. Each request will include the following response headers:

  • X-RateLimit-Limit - the total number of requests allowed in the current time window.
  • X-RateLimit-Remaining - the number of requests remaining in the current time window.
  • X-RateLimit-Reset - the time when the current time window will reset, in RFC 3339 full-date format.

If the rate limit is exceeded the Nametag API responds with status code 429 Too Many Requests and the standard Retry-After header which is the number of seconds to wait before retrying the request.

Request API

The request API is how you request proof of identity or personal information from people. This API implements and extends OAuth 2.0, so many standard OAuth 2.0 libraries will work with this interface.

Request authorization

If your user has an active web session, or is active in your mobile app, direct their browser to the /authorize endpoint. (If you do not have a web session or active mobile app at the time you are making a request, use the create request endpoint instead.)

Method: GET

URL: https://nametag.co/authorize

Authentication: none

Query parameters:

Parameter Description
client_id Your environment’s ID, from the developer console.
redirect_uri A URL that you control where the user will be directed when the authorization completes. This must be one of the values listed in the callback_urls list.
scope A space-separated list of the scopes you are requesting
state (recommended) Arbitrary data that you provide which will be passed back to the REDIRECT-URI.
response_mode (optional) Determines how authorization is passed back to your app. Either query (the default) or fragment. When you pass query to response_mode the code is passed in the URL query string, e.g. https://example.com/callback?code=CODE&state=STATE. With fragment the response is passed after a hash, e.g. https://example.com/callback#code=CODE&state=STATE.

Example: (whitespace added for clarity)

https://nametag.co/authorize?
  client_id=obo0jukwhhlbo8&
  scope=nt%3Aemail+nt%3Aname+nt%3Alegal_name&
  state=83f4e159-5cab-4002-ac5a-809f21925a67&
  redirect_uri=https%3A%2F%2Fexample.com%2Fcallback

Completing authorization

When the user completes authorization, they will be redirected to your REDIRECT-URI. This URL is invoked with the following query parameters:

Parameter Description
state The arbitrary data you provided to /authorize.
code A code which you can use with the /token endpoint to exchange for information about the person.
error A text description of an error that occurred during the process. Present only if code is not present.

Example: (whitespace added for clarity)

https://example.com/callack?
  state=83f4e159-5cab-4002-ac5a-809f21925a67&
  code=09965885d2d8559d61b520935da550f7

Token endpoint

This endpoint is defined by the OAuth 2.0 specification. It allows you to exchange the code you received at your redirect_uri for an id token and a subject which uniquely identifies the person that has accepted your sharing request.

Method: POST

URL: https://nametag.co/token

Authentication: Either specify ENV-ID and API-KEY in the body of the message, or specify the API key as the password for HTTP basic authentication.

Request: An HTML form with the following parameters

Parameter Description
grant_type must be authorization_code
client_id Your environment’s ENV-ID. (optional if basic authentication is used)
client_secret A global or environment-scoped API-KEY. (optional if basic authentication is used)
redirect_uri The redirect URI passed to /authorize.
code The code you received from the user’s request to your redirect_uri.

Response: A JSON object with the following fields:

Field Meaning
id_token This token identifies the user. It is suitable for use as e.g. a session cookie. Use it to authenticate to the /people/me API to gather information about the specific user indentified in id_token. It is safe to deliver to the user’s browser.
scope A space-separated list of the scopes returned.
expires_in The number of seconds that the authorization is valid for.
subject This value uniquely identifies the person in your environment. This is a good candidate for storing in a database to track a particular user. A subject issued to one environment has no meaning to any other environment.

Example: (whitespace added for clarity)

Request:

$ curl https://nametag.co/token \
   -d grant_type=authorization_code \
   -d client_id=obo0jukwhhlbo8 \
   -d client_secret=ef5f848e265eb423ee358cf12c5aef924c20d19356f7ad5aa07ad1614cfc4411 \
   -d code=09965885d2d8559d61b520935da550f7 \
   -d redirect_uri="https://example.com/callback"

Response:

{
  "access_token": "eyJhbGciOiJFUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiJvYXQiLCJleHAiOjE2MzcyMzg3MjUsImlhdCI6MTYzNzIzNTEyNSwiaXNzIjoibmFtZXRhZy5jbyIsIm5iZiI6MTYzNzIzNTEyNSwic3ViIjoidmtsamlwa2FpbzJhcDY2M2RvNTRyNWZwMmFANWxzcWZnMWx1cXpiOXMubmFtZXRhZy5jbyJ9.U2YAAc0TMnSJD_zKcCs_9Nayhrm5OdlcsjOQwbDSjOrBlAKI5uRCqXOoBB_oGjQjmWNYZhCYMUJShBPzSZfZZQ",
  "refresh_token": "eyJhbGciOiJFUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiJvcnQiLCJleHAiOjIxNDc0ODM2NDcsImlhdCI6MTYzNzIzNTEyNSwiaXNzIjoibmFtZXRhZy5jbyIsIm5iZiI6MTYzNzIzNTEyNSwic3ViIjoidmtsamlwa2FpbzJhcDY2M2RvNTRyNWZwMmFANWxzcWZnMWx1cXpiOXMubmFtZXRhZy5jbyJ9.5D8lexomXYJoGZNDUFmxNB3TnQIhSDleb7kTL89VLHX30bilq95PDyJ5vE3W1IdmWGxziK9IE4puIkXxBEj7LA",
  "id_token": "eyJhbGciOiJFUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiJvaXQiLCJleHAiOjIxNDc0ODM2NDcsImlhdCI6MTYzNzIzNTEyNSwiaXNzIjoibmFtZXRhZy5jbyIsIm5iZiI6MTYzNzIzNTEyNSwic3ViIjoidmtsamlwa2FpbzJhcDY2M2RvNTRyNWZwMmFANWxzcWZnMWx1cXpiOXMubmFtZXRhZy5jbyJ9.P-elo7PUVC9dIBSV_UgoFbaHc2yATNOj8jumVTF_3izs9QqZ4lslvUsfCnogc1l7oEpowCR9d2j42J6J-5LWjw",
  "scope": "nt:email nt:name nt:legal_name",
  "expires_in": 3600,
  "token_type": "Bearer",
  "subject": "vkljipkaio2ap663do54r5fp2a@5lsqfg1luqzb9s.nametag.co"
}

Create a request

Creates a new request for information from a person.

This is useful when requesting information from people over the phone, in-person, or via email. If you are integrating Nametag with a web or mobile app, you may wish to use the OAuth 2.0 authorize endpoint instead.

This API returns an identifier that can be used to track the request. It also returns a link suitable for passing to a user. Clicking this link opens the Nametag app (or app clip on iOS, or instant app on Android) and allow the user to complete the request.

If you include the optional phone parameter, then this link is sent to the user via SMS.

Method: POST

URL: https://nametag.co/api/requests

Authentication: API key

Request: A JSON object with the following fields:

Field Type Meaning
env string The ID of the Environment associated with the request
scopes list of string A list of scopes to request
phone string (optional) A phone number that will receive an authorization link via SMS
label string (optional) A internal label for the request

Response: A JSON object with the following fields:

Field Type Meaning
id string A unique identifier for this request
created_at RFC 3339 full-date Timestamp of when this request was created
updated_at RFC 3339 full-date Timestamp of the last time this request was updated
expires_at RFC 3339 full-date Timestamp of when this request expires
status number The status code for the request. Always 100 (request pending) when the request is initially created.
scopes list of string A of the scopes that were requested.
link string An authorization link. Passing this link to the user will prompt them to complete the request.
label string The label for the request

Example:

$ curl -u :$APIKEY \
  -X POST \
  https://nametag.co/api/requests \
  -d '{
    "env": "tp7975e07n8sjl",
    "scopes": ["nt:phone", "nt:legal_name"],
    "phone": "+12025551212",
    "label": "Ref Customer #41471"
}'
{
  "id": "32478070-6fc9-4b26-8f2c-5269f1222c6f",
  "status": 100,
  "scopes": ["nt:phone", "nt:legal_name"],
  "label": "Ref Customer #41471",
  "link": "https://nametag.co/i/utl2ffahuw7lqf"
}

Get a request

Fetch the status of a request.

You can also configure a webhook to receive notification when a request completes.

Method: GET

URL: https://nametag.co/api/requests/REQUEST-ID

Authentication: API key

Response: A JSON object with the following fields:

Field Type Meaning
id string A unique identifier for this request
created_at RFC 3339 full-date Timestamp of when this request was created
updated_at RFC 3339 full-date Timestamp of the last time this request was updated
expires_at RFC 3339 full-date Timestamp of when this request expires
status number The status code for the request. The value of 100 (the request is pending), 200 (the request has been accepted), 403 (the request was rejected), or 410 (the request has expired)
scopes list of string An array of the scopes that were requested
link string An authorization link. Pass this link to the user to prompt them to authorize the request.
subject string (optional) The subject of the request. Present only when status is 200. Use this as a parameter to the properties endpoint to fetch the data shared.
label string (optional) The label for the request; can be empty

Example:

When the request is complete:

$ curl -u :$APIKEY \
  -X GET \
  https://nametag.co/api/requests/32478070-6fc9-4b26-8f2c-5269f1222c6f
{
  "id": "32478070-6fc9-4b26-8f2c-5269f1222c6f",
  "status": 200,
  "scopes": ["nt:phone", "nt:legal_name"],
  "label": "Ref Customer #41471",
  "link": "https://nametag.co/i/utl2ffahuw7lqf"
  "subject": "ewyzkwmoor5xg5ead2zjswudjq@5lsqfg1luqzb9s.nametag.co"
}

Update a request

Update the label on a request; no other fields of the request can be updated and previous labels are overwritten and not retained.

Method: PATCH

URL: https://nametag.co/api/requests/REQUEST-ID

Authentication: API key

Request: A JSON object with the following fields:

Field Type Meaning
label string (optional) A label for the request; maximum 64 characters

Response: A JSON object with the following fields:

Field Type Meaning
id string A unique identifier for this request
status number The status code for the request. Always 100 (request pending) when the request is initially created.
scopes list of string An array of the scopes that were requested.
link string An authorization link. Passing this link to the user will prompt them to complete the request.
label string The label for the request

Example:

$ curl -u :$APIKEY \
  -X PATCH \
  https://nametag.co/api/requests \
  -d '{
    "label": "updated label text"
}'
{
  "id": "32478070-6fc9-4b26-8f2c-5269f1222c6f",
  "status": 100,
  "scopes": ["nt:phone", "nt:legal_name"],
  "link": "https://nametag.co/i/utl2ffahuw7lqf",
  "label": "updated label text"
}

Cancel a request

Abort a request, invalidating the link for this request that was returned or sent via SMS when it was created. If the user has opened the request on their mobile device, it will close with a message that the request was canceled.

Method: DELETE

URL: https://nametag.co/api/requests/REQUEST-ID

Authentication: API key

Example:

When the request is complete:

$ curl -u :$APIKEY \
  -X DELETE \
  https://nametag.co/api/requests/32478070-6fc9-4b26-8f2c-5269f1222c6f

People API

The People API allows you to fetch and manage the data that people have shared with you.

Get properties

Method: GET

URL: https://nametag.co/people/SUBJECT/properties/SCOPES

Authentication: API key for any subject, or an ID token is if SUBJECT is special value me.

Parameters:

  • SUBJECT - The subject you got back from the token endpoint which uniquely identifies the person. You can use the special value me with ID token authentication to fetch information about the person for whom the ID token was issued.

  • SCOPES - A comma-separated list of the scopes you want to fetch.

Response:

{
  "env_id": "ENV",
  "subject": "SUBJECT",
  "properties": [ PROPERTY, ... ]
  "requests": [ REQUEST, ... ]
}

The response contains a list of properties that you requested. Each PROPERTY has the following fields:

Field Type Description
scope string The scope you requested.
value varies with scope The value of the property. The type of this field varies depending on the scope. See this table.
expires RFC 3339 date-time When your access to this data expires
status int A value that tells you the disposition of the property. The value 200 means the data was shared. The value 403 means the data has not been shared, the person has revoked your access, or 410 meaning the request has expired.

Each request describes a single request for information. The REQUEST has the following fields:

Field Type Description
created_at RFC 3339 date-time The time that the request was initiated
id string The ID of the request (use with the requests API
scopes list of string The scopes requested
status int The status of the request, 200 means accepted, 403 means rejected or canceled.

Errors:

  • 400 Bad Request - The one or more of the scopes provided are invalid or not registered.

Example:

$ SUBJECT=vkljipkaio2ap663do54r5fp2a@5lsqfg1luqzb9s.nametag.co
$ curl -u ":$API_KEY" \
  "https://nametag.co/people/$SUBJECT/properties/nt:email,nt:legal_name"

Response:

{
  "subject": "vkljipkaio2ap663do54r5fp2a@5lsqfg1luqzb9s.nametag.co",
  "properties": [
    {
      "expires": 1637321520,
      "scope": "nt:email",
      "value": "ross@nametag.co",
      "status": 200
    },
    {
      "expires": 1637321520,
      "scope": "nt:legal_name",
      "value": "Ross Kinder",
      "status": 200
    }
  ],
  "requests": [
    {
      "created_at": "2022-12-18T19:15:42.315853Z",
      "id": "f5cb153e-b96a-42c6-a1c0-f5a27d065fea",
      "scopes": [
        "nt:email",
        "nt:legal_name"
      ],
      "status": 200
    }
  ]
}

Example using ID token:

$ ID_TOKEN=eyJhbGciOiJFUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiJvaXQiLCJleHAiOjIxNDc0ODM2NDcsImlhdCI6MTYzNzIzNTEyNSwiaXNzIjoibmFtZXRhZy5jbyIsIm5iZiI6MTYzNzIzNTEyNSwic3ViIjoidmtsamlwa2FpbzJhcDY2M2RvNTRyNWZwMmFANWxzcWZnMWx1cXpiOXMubmFtZXRhZy5jbyJ9.P-elo7PUVC9dIBSV_UgoFbaHc2yATNOj8jumVTF_3izs9QqZ4lslvUsfCnogc1l7oEpowCR9d2j42J6J-5LWjw
$ curl -u ":$ID_TOKEN" \
  "https://nametag.co/people/$SUBJECT/properties/nt:email,nt:legal_name"

Response:

{
  "subject": "vkljipkaio2ap663do54r5fp2a@5lsqfg1luqzb9s.nametag.co",
  "properties": [
    {
      "expires": 1637321520,
      "scope": "nt:email",
      "value": "ross@nametag.co",
      "status": 200
    },
    {
      "expires": 1637321520,
      "scope": "nt:legal_name",
      "value": "Ross Kinder",
      "status": 200
    }
  ]
}

Delete properties

A person may revoke your access to a scope at any time. Less commonly, you can also remove a user’s access, for example if a user deletes their account or requests that their data be unshared via your app.

Method: DELETE

URL: https://nametag.co/people/SUBJECT/properties/SCOPES

Authentication: API key for any subject. ID token is if the subject is special value me.

Parameters:

  • SUBJECT - The subject you got back from the /token endpoint which uniquely identifies the person. You can use the special value me with ID token authentication to revoke a scope on behalf of a person to whom the ID token was issued.
  • SCOPES - A comma-separated list of the scopes you want to revoke.

Request: none

Response: none

Example:

CLIENT_ID=obo0jukwhhlbo8
CLIENT_SECRET=ed1227ffbd35ff2b83bc8bd2c6af6473e596be875f094ef08da6a3c041d584f0
SUBJECT=vkljipkaio2ap663do54r5fp2a@5lsqfg1luqzb9s.nametag.co
curl -u "$CLIENT_ID:$CLIENT_SECRET" \
  -X DELETE \
  "https://nametag.co/people/$SUBJECT/properties/nt:email,nt:legal_name"

Get properties in bulk

This endpoint returns properties for multiple people at a time. For each person, specify the subject and the scopes you are requesting. The response will contain an object for each of the subjects you provided.

Note: We recommend a batch size of around 512 people per request. The Nametag API does not strictly limit the number of items that you request, but the requests that are too large may fail due to timeouts or size restrictions on the response.

Method: POST

URL: https://nametag.co/people/bulk

Authentication: API key

Request body:

{
  "requests": [ BULK-REQUEST, ... ]
}

Each BULK-REQUEST is an object consisting of the following fields:

Field Type Description
subject string The SUBJECT returned from the token endpoint
scopes list of string The scopes requested

Response:

The response will contain one entry corresponding to item in the requests list.

{
  "data": [
    {
      "subject": "SUBJECT",
      "properties": [ PROPERTY, ... ],
    },
    ...
  ]
}

Example:

curl -u ":$API_KEY" https://nametag.co/people/bulk \
  -d '{
  "requests": [
    {
      "subject": "vkljipkaio2ap663do54r5fp2a@5lsqfg1luqzb9s.nametag.co",
      "scopes": [
        "nt:email",
        "nt:legal_name"
      ]
    }
  ]
}'

Response:

{
  "data": [
    {
      "subject": "vkljipkaio2ap663do54r5fp2a@5lsqfg1luqzb9s.nametag.co",
      "properties": [
        {
          "expires": 1637321520,
          "scope": "nt:email",
          "value": "ross@nametag.co",
          "status": 200
        },
        {
          "expires": 1637321520,
          "scope": "nt:legal_name",
          "value": "Ross Kinder",
          "status": 200
        }
      ]
    }
  ]
}

Compare values

This endpoint compares a set of expected values of a scope for a subject and returns a confidence score that tells you if the subject matches what you expect.

This is useful if your user already has an account with your service and you need to connect them to a Nametag subject.

Note: For now, the only supported scope is nt:legal_name.

Method: POST

URL: https://nametag.co/people/:subject/compare

Authentication: API key

Request body:

{
  "expectations": [
    {
      "scope": "nt:legal_name",
      "value": "Alice Smith",
    },
  ]
}

Response:

The response will contain one entry corresponding to each item in the expectations array. The scope and value from the request will be echoed back as scope and expected, respectively. The value is the actual value of the scope (as would be returned from the get properties endpoint. The confidence that the expected data matches the actual value of the scope is returned as a float in the range 0.0-1.0 as match_confidence.

{
  "confidence": 0.9,
  "comparisons": [
    {
      "scope": "nt:legal_name",
      "expected": "First Last",
      "value": "First Middle Last",
      "match_confidence": 0.9
    }
  ]
}

Webhooks

Webhooks allow you to handle events initiated by Nametag. When events of interest occur, our service will make an HTTPS request to your service. Webhooks are configured on a per-environment basis in the developer console.

Authentication: Your service should verify that the requests to your webhook endpoint actually originate from Nametag. Each request to your service includes a header X-Nametag-Signature whose value is the hex-encoded HMAC-SHA256 of the body of the request using the webhook’s SHARED-SECRET as the key. The shared secret can be found in the developer console.

Retries: If your service returns an error status code (>= 400), or if we cannot connect due to a network or certificate error, then Nametag will retry the request up to five times at 30 second intervals. You can see a history of our attempts to deliver webhooks in the developer console.

Note: Your service must present a valid, publicly trusted SSL/TLS certificate. For development, we recommend ngrok. For production use we recommend Let’s Encrypt

Share event

This event is emitted whenever a person shares information with you, or when they update information they have previously shared.

Event type: share

Request body:

{
  "event_type": "share",
  "subject": "SUBJECT",
  "request": "REQUEST_ID",
  "scopes": ["SCOPE", ...]
}

Example: (whitespace has been added to the response for clarity)

POST https://example.com/webhook HTTP/1.1
Date: Thu, 18 Nov 2021 11:55:09 GMT
Content-type: application/json
User-agent: Nametag-Webhooks/20211116T214921.7e635fd.ci
X-Nametag-ID: 925dfd28-5213-42d9-9320-f1f6d0c8de09
X-Nametag-Signature: a2053d3c5981abb85600b9176b4c251d4a5056270a95e53be3bfbf4929c4a563

{
  "event_type": "share",
  "subject": "vkljipkaio2ap663do54r5fp2a@5lsqfg1luqzb9s.nametag.co",
  "scopes": [
    "nt:email",
    "nt:legal_name",
    "nt:name"
  ]
}

Example: Verifying the signature

$ WEBHOOK_SHARED_SECRET=webhook-683fb6598c7faa4f05e4e693d3686f5faa6b9cd7bb646c5254edd3cb880f4225
$ echo -n '{"event_type":"share",'\
    '"subject":"vkljipkaio2ap663do54r5fp2a@5lsqfg1luqzb9s.nametag.co",'\
    '"scopes":["nt:email","nt:name","nt:legal_name"]}' |\
  openssl dgst -sha256 -hmac "$WEBHOOK_SHARED_SECRET"
a2053d3c5981abb85600b9176b4c251d4a5056270a95e53be3bfbf4929c4a563

The event request body contains the following fields:

Field Type Description
event_type string Always "share" for this event type
subject string The subject that shared the data
request_id string The ID of the most recent request which was returned by the create a request API, if used. This field may be omitted when the user changes shared data outside the context of a pending request, such as by using the “Vault” tab in the Nametag app.
scopes list of string The list of currently shared scopes

Revoke event

This event is emitted when a person revokes access to information they’ve previously shared with you.

Event type: revoke

Request body:

{
  "event_type": "revoke",
  "subject": "/* the person's subject */",
  "scopes": ["nt:name", "nt:age_over_21"]
}

Example:

POST https://trynametag.com/webhook HTTP/1.1
Date: Thu, 18 Nov 2021 11:55:23 GMT
Content-type: application/json
User-agent: Nametag-Webhooks/20211116T214921.7e635fd.ci
X-Nametag-ID: 4f94f7a0-5bdf-409b-ae84-2aff8c95eab0
X-Nametag-Signature: b7aad74f36f50e7b15112bea178b25001c45726715cf19a4328e5b22f89a9b7f

{
  "event_type": "reject",
  "subject": "vkljipkaio2ap663do54r5fp2a@5lsqfg1luqzb9s.nametag.co",
  "scopes": [
    "nt:email",
    "nt:legal_name",
    "nt:name"
  ]
}

The event request body contains the following fields:

Field Type Description
event_type string Always "share" for this event type
subject string The Subject that initially shared the data
scopes list of string The list of revoked scopes

Data types

Government ID Details

When fetching a property with the scope nt:govtid_details, the data returned is a JSON object with the following structure:

Field Type Description
type string The type of document. driver_license or passport.
issuer string The authority that issued the document. For passports, this is the ISO 3166-1 Alpha-3 country code (e.g. USA). For driver licenses, this is the country code followed by a country-specific identifier for the state or province (e.g. USA.CA)
number string The identifying number of the driver license or passport.
expiration RFC 3339 full-date The date after which the document is no longer valid

COVID Vaccination

When fetching a property with the scope nt:covid_vaccine or nt:covid_card, the data returned is a JSON object with the following structure:

Field Type Description
status string The vaccination status of the person. One of: peak meaning that they are fully vaccinated, partial meaning that they have received at least one vaccine dose, or that they have received the required number of doses but that not enough time has passed for the vaccine to be fully effective.
manufacturer string The type of vaccine they received. Possible values are pfizer, moderna, jj, oxford, novavax, covishield, sinovac, sinopharm, sputnik, and covaxin.
dose1_date RFC 3339 full-date The date of their first dose
dose2_date RFC 3339 full-date The date of their second dose. If they have not received a second dose, then this value is an empty string.
booster_date RFC 3339 full-date The date of their booster dose. If they have not received a booster dose, then this value is an empty string. Booster doses do not affect the immunity calculation in status.
peak_immunity_after RFC 3339 full-date The date after which the person will be considered to have peak immunity status.
validated boolean This value is true if the vaccine evidence provided has been verified to match the information provided. If this value is false is means that the person has attested to the information but it has not yet been verified. This is most likely to occur when a person has presented non-standard vaccination evidence that must be manually validated. Manual validations usually take no more than a few hours.
evidence_image_url string Present only for the nt:covid_card scope. A URL that contains an image of the evidence that the person submitted. This URL is valid for only a short time (several minutes) after the response is received from Nametag.

Age estimation API

Use the age estimation API to determine if a photo of a person appears to be older than the age specified. This is useful as a preliminary gate for determining if ID validation is required for proof of age. For example, if you want to ensure that users are over 18 years of age, you might use this API with a threshold of 25, and if the user doesn’t pass, then direct them to a request with the nt:age_over_18.

Note: This API is not enabled by default because it comes with specific handling and legal requirements. Contact help@nametag.co to enable this API.

Using the age estimation API consists of three steps:

  1. Create a request, specifying the age threshold and the hash of the image.
  2. Upload the image to the URL provided by the API.
  3. Fetch the results of the age estimation.

Regional Considerations

By default, the age estimation analysis will be performed in the region closest to you when you initiate the request. If you prefer the age estimation to be performed in another region, use the region-specific hosts, https://eu.nametag.co or https://us.nametag.co.

Start a request

Create a new age verification request. You must provide the SHA256-checksum of the image you intend to upload and one of two age thresholds; valid values are 25 or 30.

The response contains a URL that you must use to make an HTTP PUT with the image of the person’s face in the request body. The URL returned is single-use, does not require authentication beyond what is embedded in the URL. This means that it is safe to pass to an end user or device for them to upload the image and thus you don’t have to handle the actual image if you don’t want to.

Method: POST

URL: https://nametag.co/api/age

Authentication: API key

Request:

{
  "age_threshold": 25,
  "sha256sum": "e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855"
}

Response:

{
  "id": "AGE_ESTIMATE_ID"
  "upload_url": "UPLOAD_URL"
}

Get an age estimate

After you upload the image to the upload URL, fetch the results using the id returned when the request was initiated.

Method: GET

URL: https://nametag.co/api/age/:id

Authentication: API key

Response:

{
  "status": STATUS
}

The STATUS is one of the following values:

  • 200 - the person appears to be older than the threshold specified.
  • 403 - the person does not appear to be older than the threshold specified.
  • 400 - the image does not appear to be a person, contains multiple people, the hash is incorrect, or the image is otherwise defective; the age threshold requested isn’t either 25 or 30

Example

$ export APIKEY="..."

# determine the hash of the image
$ sha256sum face.jpg
e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855

# start the process
$ curl -u :$APIKEY https://nametag.co/api/age -d '{"age_threshold": 25, "sha256sum": "e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855"}'
{
  "id": "c91f59bf-bc97-4fb4-85f5-649de8bd6911",
  "upload_url": "https://upload.nametag.co/e3b/0c4/e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855?auth=37a78a29-71d7-4e0b-a276-be6bcb62b927",
}

# upload the image
$ curl -d @face.jpg "https://upload.nametag.co/e3b/0c4/e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855?auth=37a78a29-71d7-4e0b-a276-be6bcb62b927"

# get the status
$ curl -u :$APIKEY https://nametag.co/api/age/c91f59bf-bc97-4fb4-85f5-649de8bd6911
{
  "status": 200
}

Configuration API

Use the configuration API to manage the configuration of your organizations and environments. All requests to the configuration API are authenticated with API keys.

Environment

An environment is the unit of privacy isolation in Nametag. The Environment object contains the following fields:

Field Type Description
id string The identifier for this environment
org string The organization identifier that owns this environment
name string The internal name for this environment, e.g. “Live”
public_name string The name of the environment that is shared with people, e.g. “Acme Corporation”
description string A description of what your company or app does. Displayed to people in the Nametag mobile app.
logo_url string A URL to your logo, which is displayed in the Nametag mobile app.
terms_of_service_url string A URL that points to your terms of service or privacy policy, e.g. https://example.com/privacy. This is linked in the Nametag mobile app.
scopes list of ScopeDefinition Defines which scopes you will request.
callback_urls list of string A list of URLs that are acceptable as a redirect_uri parameter to /authorize.
webhook_shared_secret string The shared secret to be used for authenticating webhooks.
webhooks list of WebhookDefinition A list of webhooks.

ScopeDefinition

The type ScopeDefinition defines a scope that you may request.

Field Type Description
scope string The scope that you will request.
expires_in integer How long will data for the scope be valid, in seconds.
restrict_email_domains list of string For the nt:email scope only, require that each value be in the specified domain.

WebhookDefinition

The type WebhookDefinition defines a webhook. It contains the following fields:

Field Type Description
url string The URL in your service that should be called, e.g. https://example.com/__callback
enabled boolean If true, then calls to this webhook should be made.
events list of string The names of the events that should be sent.

List environments

Returns a list of all environments that you have access to.

Method: GET

URL: https://nametag.co/api/envs

Authentication: API key

Response:

{
  "envs": [ ENV, ... ]
}

Example:

$ export APIKEY="..."
$ curl -u :$APIKEY https://nametag.co/api/envs

Response:

{
  "envs": [
    {
      "id": "5lsqfg1luqzb9s",
      "org": "tp7975e07n8sjl",
      "name": "Sidecar Production",
      "public_name": "Sidecar",
      "description": "Like Uber, but for rides in motorcycle sidecars.",
      "logo_url": "https://nametagusercontent.com/app-icons/fa21/f7d7/fa21f7d7e4d2eacec7331de48df71e29cfe5fca2d8c629634e9e69a2042c26b9",
      "terms_of_service_url": "https://example.nametag.co/terms",
      "scopes": [
        {
          "scope": "nt:name",
          "expires_in": 86400,
          "reason": "",
          "priority": 0,
          "restrict_email_domains": null
        },
        {
          "scope": "nt:email",
          "expires_in": 86400,
          "reason": "",
          "priority": 0,
          "restrict_email_domains": null
        },
        {
          "scope": "nt:legal_name",
          "expires_in": 86400,
          "reason": "",
          "priority": 0,
          "restrict_email_domains": null
        }
      ],
      "callback_urls": [
        "https://trynametag.com/callback"
      ],
      "webhook_shared_secret": "webhook-683fb6598c7faa4f05e4e693d3686f5faa6b9cd7bb646c5254edd3cb880f4225",
      "webhooks": [
        {
          "url": "https://trynametag.com/webhook",
          "enabled": true,
          "events": [
            "share",
            "reject"
          ]
        }
      ]
    }
  ]
}

Create

Creates a new environment

Method: POST

URL: https://nametag.co/api/envs

Authentication: API key

Request:

{
  "org": "ORG-ID"
}

Response:

{
  "id": "ENV-ID"
}

Example:

$ curl -u :$APIKEY \
    -X POST \
    https://nametag.co/api/envs  -d '{
      "org": "tp7975e07n8sjl"
    }'

Response:

{
  "id": "x0n8vfkfcmh3ks"
}

Get

Fetch the settings for an environment.

Method: GET

URL: https://nametag.co/api/envs/ENV-ID

Authentication: API key

Response: an Environment object

Example:

curl -u :$APIKEY https://nametag.co/api/envs/x0n8vfkfcmh3ks

Response:

{
  "id": "5lsqfg1luqzb9s",
  "org": "tp7975e07n8sjl",
  "name": "Sidecar Production",
  "public_name": "Sidecar",
  "description": "Like Uber, but for rides in motorcycle sidecars.",
  "logo_url": "https://nametagusercontent.com/app-icons/fa21/f7d7/fa21f7d7e4d2eacec7331de48df71e29cfe5fca2d8c629634e9e69a2042c26b9",
  "terms_of_service_url": "https://example.nametag.co/terms",
  "scopes": [
    {
      "scope": "nt:name",
      "expires_in": 86400,
      "reason": "So we can address you in our app and on the web.",
      "priority": 20
    },
    {
      "scope": "nt:email",
      "expires_in": 86400,
      "reason": "So we can send you updates about your Sidecar account",
      "priority": 10
    },
    {
      "scope": "nt:legal_name",
      "expires_in": 86400,
      "reason": "So we know you are a real person",
      "priority": 30
    }
  ],
  "callback_urls": [
    "https://trynametag.com/callback"
  ],
  "webhook_shared_secret": "webhook-683fb6598c7faa4f05e4e693d3686f5faa6b9cd7bb646c5254edd3cb880f4225",
  "webhooks": [
    {
      "url": "https://example.com/webhook",
      "enabled": true,
      "events": [
        "share",
        "reject"
      ]
    }
  ]
}

Update

Change settings for an environment. All the request fields are optional, and only fields that are provided will be changed.

Method: PATCH

URL: https://nametag.co/api/envs/ENV-ID

Authentication: API key

Request:

Each field of the request is optional. Refer to the Environment object for descriptions of each field.

Field Type Description
name string Update the name of the environment
public_name string Update the public name of the environment
description string Update the description
logo_url string Update the logo URL
terms_of_service_url string Update the terms of service URL.
add_scopes list of ScopeDefinition Add scopes to the environment
remove_scopes list of string Remove scopes from the environment.
callback_urls list of string Set the list of allowed OAuth 2.0 callback URLs
remove_webhooks list of string Remove webhooks from the environment (URLs of the webhooks to remove)
add_webhooks list of WebhookDefinition Add webhooks to the environment

To modify a scope or webhook, include both the remove_* and add_* in the same request. For example, to replace an ScopeDefinition, include both remove_scopes and add_scopes in your request.

Example:

$ curl -u :$APIKEY https://nametag.co/api/envs/x0n8vfkfcmh3ks -X PATCH -d '{
  "name": "Example app",
  "remove_scopes": ["nt:name"],
  "add_scopes": [
    {
      "scope": "nt:name",
      "expires_in": 3600,
      "reason": "So we can address you",
      "priority": 23
    }
  ]
}'

Method: POST

URL: https://nametag.co/api/envs/ENV-ID/logo

Authentication: API key

Request: A PNG, SVG, or JPEG of your service’s logo. Set the Content-type request header to one of image/png, or image/svg+xml, or image/jpeg.

Response: none

Example:

$ curl -u :$APIKEY \
    -X POST \
    -H "Content-type: image/png" \
    -T "logo512.png" \
    https://nametag.co/api/envs/x0n8vfkfcmh3ks/logo

# check the environment
$ curl -u :$APIKEY https://nametag.co/api/envs/x0n8vfkfcmh3ks | jq -r .logo_url
https://nametagusercontent.com/app-icons/fa21/f7d7/fa21f7d7e4d2eacec7331de48df71e29cfe5fca2d8c629634e9e69a2042c26b9

Remove

Remove an environment.

Method: DELETE

URL: https://nametag.co/api/envs/ENV-ID

Request: none

Response: none

$ curl -u :$APIKEY \
    -X DELETE \
    https://nametag.co/api/envs/x0n8vfkfcmh3ks

Organizations

An organization is a container for your environments. Each organization has members, which are people that have access to management information about your environments.

List

List the organizations that you have access to.

Method: GET

URL: https://nametag.co/api/orgs

Authentication: API key

Response:

{
  "orgs": [
    {
      "id": "...",
      "name": "Acme Corp",
      "role": "owner"
    }
  ]
}

Each item of orgs is an object that contains the following fields:

Field Type Description
id string The unique identifier for the organization
name string The name of the organization
role string Your role on the organization, which is either admin or reader.

Example:

curl -u :$APIKEY https://nametag.co/api/orgs

Response:

{
  "orgs": [
    {
      "id": "tp7975e07n8sjl",
      "name": "Acme Corp",
      "role": "admin"
    }
  ]
}

Create

Create a new organization. This request takes the name of the new organization to create and returns a unique identifier for the newly created organization.

Note: Organization names are internal. Only members see the name of an organization.

Method: POST

URL: https://nametag.co/api/orgs

Authentication: API key

Request:

{
  "name": "Acme Corporation"
}

Response:

{
  "id": "ORG-ID"
}

Example:

$ curl -u :$APIKEY \
  https://nametag.co/api/orgs \
  -d '{"name": "Acme Corporation"}'

Response:

{"id":"7kpb46mqpduu36"}

Get

Fetch information about an organization

Method: GET

URL: https://nametag.co/api/orgs/ORG-ID

Authentication: API key

Request: none

Response:

{
  "id": "ENV-ID",
  "name": "Acme Corp",
  "role": "owner"
}

List members

Returns a list of the current members of an organization

Method: GET

URL: https://nametag.co/api/orgs/ORG-ID/members

Authentication: API key

Request: none

Response:

{
  "members": [ ORG-MEMBER, ... ]
}

Each ORG-MEMBER is an object consisting of:

Field Type Description
member_id string An identifier for the fact of this person being a member of the specified organization.
role string The person’s role on the organization. One of reader, admin, or owner
name string The person’s name
email string The person’s email address
invited_email string The email address that was invited to the organization (which could differ from the email address they entered into their Nametag app)
profile_picture URL A URL to the person’s preferred profile picture. Nametag checks that the image provided is the same person as pictured on their identity document.
is_self boolean true if this person is you

Invite a person to an organization

Invites a new person to join an organization. This API sends an email to the address specified. When the person accepts the invitation, they will have joined the organization. The person must use the Nametag app to authenticate prior to joining the organization.

Method: POST

URL: https://nametag.co/api/orgs/ORG-ID/members

Authentication: API key

Request:

{
  "email": "alice@example.com"
}

Response: none

Remove an organization member

Removes a person from an organization.

Method: DELETE

URL: https://nametag.co/api/orgs/ORG-ID/members/MEMBER-ID

Authentication: API key

Request: none

Response: none

Set an organization member’s role

Assign a role to an organization member

Method: PATCH

URL: https://nametag.co/api/orgs/ORG-ID/members/MEMBER-ID

Request:

{
  "role": "admin"
}

The role must be one of reader, or admin. You must have at least one active member marked as admin.

Response: none

API Keys

As mentioned in Authentication above, API keys are used to authenticate request to the Nametag API. An API key may be global (meaning it applies to all Environments), or it may be local (it applies only to one environment).

List

List the API Keys that you have access to.

Method: GET

URL: https://nametag.co/api/apikeys

Query Parameters:

You must specify exactly one of the following parameters:

Parameter Description
org Fetch API keys for the specified organization.
env Fetch API keys only for the specified environment.

Authentication: API key

Response:

{
  "apikeys": [
    {
      "id": "06c6a11a-c78e-488f-9b58-f73362309ea0",
      "org": "k2mb4yifkaqo5s",
      "name": "Staging API Key",
      "created_at": "2022-03-15T22:39:59Z",
      "role": "admin",
      "enabled": true
    }
  ]
}

Each item of apikeys is an object that contains the following fields:

Field Type Description
id string The unique identifier for the API key
name string The name of the API key
org string The unique identifier for the organization this API key belongs to
env string The unique identifier for the environment this API key belongs to, or an empty string if the key applies to all environments in the organization.
role string The role associated with this key, either reader or admin.
enabled boolean Flag indicating if this API key is enabled.
created_at RFC 3339 full-date The datetime the API Key was created at

Example:

curl -u :$APIKEY https://nametag.co/api/apikeys

Response:

{
  "apikeys": [
    {
      "id": "06c6a11a-c78e-488f-9b58-f73362309ea0",
      "org": "k2mb4yifkaqo5s",
      "name": "Staging API Key",
      "created_at": "2022-03-15T22:39:59Z",
      "role": "admin",
      "enabled": true
    }
  ]
}

Create

Create a new API key. This request takes the ID of the organization this API Key belongs to and an optional name for the API key to create and returns the newly created API key string that must be stored for future usage.

Note: API key names are internal. Only organization members see the name of an API Key.

API keys are not stored by Nametag, so be sure to copy the response somewhere safe for future usage.

Method: POST

URL: https://nametag.co/api/apikeys

Authentication: API key

Request:

Create a global API key:

{
  "name": "Staging API Key",
  "org": "k2mb4yifkaqo5s",
  "role": "admin",
  "enabled": true
}

Create an environment-scoped API key

{
  "name": "Staging API Key",
  "env": "obo0jukwhhlbo8",
  "role": "reader",
  "enabled": true
}

Response:

{
  "id": "3p0wjj3b7vyia5",
  "key": "3p0wjj3b7vyia5V2JCNoO3TqHpjT"
}

Example:

$ curl -u :$APIKEY \
  https://nametag.co/api/apikeys \
  -d '{"name": "Staging API Key", "org": "k2mb4yifkaqo5s"}'

Response:

{"key":"3p0wjj3b7vyia5V2JCNoO3TqHpjT"}

Get

Fetch information about an API key

Method: GET

URL: https://nametag.co/api/apikeys/API-KEY-ID

Authentication: API key

Request: none

Response:

{
  "id": "06c6a11a-c78e-488f-9b58-f73362309ea0",
  "org": "k2mb4yifkaqo5s",
  "name": "Staging API Key",
  "created_at": "2022-03-15T22:39:59Z",
  "role": "admin",
  "enabled": true
}

  1. When addressing a user, you should a person’s preferred name over their legal name, unless it is strictly necessary for your use case. This is because many people’s names on their identity documents do not match the name they would prefer you use. ↩︎

  2. For correctness and inclusivity, you should prefer a person’s full name over using the first and last names. See Falsehoods Programmers Believe About Names for details. ↩︎ ↩︎ ↩︎ ↩︎