Get Originated Identity (PII)

GET/users/{user_id}/identity

The PII supplied at user creation (email, names), the customer’s own originated data, returned nulls-included for shell users. Distinct from GET …/accounts/{account_id}/identity, which is the administrator-reported owner of a specific account. Requires the identity key scope and an ephemeral token with the identity token scope. No connection product applies (the data has no connection source).

Path Parameters

user_idstringrequired

The Sail user id.

Response

Originated identity.

emailstring

The email supplied at user creation. Null if not provided.

first_namestring

The first name supplied at user creation. Null if not provided.

last_namestring

The last name supplied at user creation. Null if not provided.

phonestring

The phone number supplied at user creation. Null if not provided.

addressobject

The address supplied at user creation. Null if not provided.

Show address properties

streetstring

Street address.

citystring

City.

statestring

State or region.

zipstring

Postal code.

countrystring

Country.

user_token_required / user_token_expired / invalid_user_token.

insufficient_key_scope or insufficient_token_scope.

Standard error envelope covering 400, 401, 403, 404, 429, and 500.

errorobject

The error detail.

Show error properties

codestring

Machine-readable code, e.g. not_found, token_scope_mismatch, product_not_enabled, insufficient_key_scope, insufficient_token_scope, user_token_required, user_token_expired, invalid_user_token, invalid_key_configuration, connection_not_reconnectable, rate_limited.

messagestring

Human-readable error message. May change, so match on error.code instead.

paramstring

The request field that caused the error, when applicable. Null otherwise.

const response = await fetch(`https://live.savewithsail.com/api/v1/users/${user_id}/identity`, { method: 'GET', headers: { 'Authorization': 'Bearer <token>', 'x-sail-user-token': '<x-sail-user-token>' } }); const data = await response.json();

import requests response = requests.request( "GET", "https://live.savewithsail.com/api/v1/users/{user_id}/identity", headers={ "Authorization": "Bearer <token>", "x-sail-user-token": "<x-sail-user-token>" }, ) data = response.json()

<?php $ch = curl_init(); curl_setopt($ch, CURLOPT_URL, "https://live.savewithsail.com/api/v1/users/<user_id>/identity"); curl_setopt($ch, CURLOPT_RETURNTRANSFER, true); curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "GET"); curl_setopt($ch, CURLOPT_HTTPHEADER, ["Authorization: Bearer <token>", "x-sail-user-token: <x-sail-user-token>"]); $response = curl_exec($ch); curl_close($ch);

package main import ( "fmt" "io" "net/http" ) func main() { req, _ := http.NewRequest("GET", "https://live.savewithsail.com/api/v1/users/<user_id>/identity", nil) req.Header.Set("Authorization", "Bearer <token>") req.Header.Set("x-sail-user-token", "<x-sail-user-token>") resp, err := http.DefaultClient.Do(req) if err != nil { panic(err) } defer resp.Body.Close() data, _ := io.ReadAll(resp.Body) fmt.Println(string(data)) }

HttpClient client = HttpClient.newHttpClient(); HttpRequest request = HttpRequest.newBuilder() .uri(URI.create("https://live.savewithsail.com/api/v1/users/<user_id>/identity")) .header("Authorization", "Bearer <token>") .header("x-sail-user-token", "<x-sail-user-token>") .method("GET", HttpRequest.BodyPublishers.noBody()) .build(); HttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.ofString()); System.out.println(response.body());

require "net/http" require "uri" uri = URI("https://live.savewithsail.com/api/v1/users/<user_id>/identity") http = Net::HTTP.new(uri.host, uri.port) http.use_ssl = uri.scheme == "https" request = Net::HTTP::Get.new(uri) request["Authorization"] = "Bearer <token>" request["x-sail-user-token"] = "<x-sail-user-token>" response = http.request(request) puts response.body

{ "email": "string", "first_name": "string", "last_name": "string", "phone": "string", "address": { "street": "string", "city": "string", "state": "string", "zip": "string", "country": "string" } }