Identities
Create identity
Create a new identity with the Go SDK.
POST
/
identities
Create identity
curl --request POST \
--url http://localhost:5001/identities \
--header 'X-blnk-key: <api-key>'import requests
url = "http://localhost:5001/identities"
headers = {"X-blnk-key": "<api-key>"}
response = requests.post(url, headers=headers)
print(response.text)const options = {method: 'POST', headers: {'X-blnk-key': '<api-key>'}};
fetch('http://localhost:5001/identities', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_PORT => "5001",
CURLOPT_URL => "http://localhost:5001/identities",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_HTTPHEADER => [
"X-blnk-key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "http://localhost:5001/identities"
req, _ := http.NewRequest("POST", url, nil)
req.Header.Add("X-blnk-key", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("http://localhost:5001/identities")
.header("X-blnk-key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("http://localhost:5001/identities")
http = Net::HTTP.new(url.host, url.port)
request = Net::HTTP::Post.new(url)
request["X-blnk-key"] = '<api-key>'
response = http.request(request)
puts response.read_bodyUse
Go response (
client.Identity.Create to create an identity for an individual or organization.
1
Call the method
client.Identity.Create
dob, _ := time.Parse(time.RFC3339, "1990-01-15T00:00:00Z")
identity, resp, err := client.Identity.Create(blnkgo.Identity{
IdentityType: blnkgo.Individual,
FirstName: "Alice",
LastName: "Smith",
EmailAddress: "alice.smith@example.com",
DOB: &dob,
MetaData: blnkgo.MetaData{
"customer_id": "CUST123456",
},
})
| Field | Type | Description |
|---|---|---|
IdentityType | blnkgo.IdentityType | Individual or Organization. |
Show Optional parameters
Show Optional parameters
| Field | Type | Description |
|---|---|---|
IdentityID | string | Optional ID you can set yourself. Must be idt_ + UUID. Blnk generates one if you omit it. |
OrganizationName | string | Name of the organization. |
FirstName | string | First name of the individual. |
LastName | string | Last name of the individual. |
OtherNames | string | Any other names for the individual. |
Gender | string | Gender of the individual. |
DOB | *time.Time | Date of birth. Parse with time.Parse(time.RFC3339, "..."). |
EmailAddress | string | Email address. |
PhoneNumber | string | Contact number. |
Nationality | string | Nationality of the individual. |
Category | string | Your own customer category. |
Street | string | Street address. |
Country | string | Country of residence. |
State | string | State of residence. |
PostCode | string | Postal code. |
City | string | City of residence. |
MetaData | MetaData | Optional metadata. |
2
Response
201 Created
{
"identity_id": "idt_a8f2c91d-4b3c-4ef4-9ab1-a0decf3d0aa3",
"identity_type": "individual",
"first_name": "Alice",
"last_name": "Smith",
"email_address": "alice.smith@example.com",
"phone_number": "+1234567890",
"nationality": "Canadian",
"category": "customer",
"created_at": "2024-11-26T08:36:36.238244338Z",
"meta_data": {
"customer_id": "CUST123456"
}
}
Go response (*blnkgo.IdentityResponse)
| Field | Type | Description |
|---|---|---|
IdentityId | string | Unique ID for the identity. |
IdentityType | blnkgo.IdentityType | Type you passed in the request. |
FirstName | string | First name of the individual. |
LastName | string | Last name of the individual. |
EmailAddress | string | Email address. |
CreatedAt | string | Date and time the identity was created. |
MetaData | MetaData | Metadata stored with the identity. |
Need help?
We are very happy to help you make the most of Blnk, regardless of whether it is your first time or you are switching from another tool. To ask questions or discuss issues, please contact us or join our Discord community.Was this page helpful?
⌘I