Identity

SDK reference for the Identity service — create, verify, and manage customer identities.

The Identity service manages KYC (Know Your Customer) verification for individuals and institutions. Identities must be verified before they can transact.

Client accessor: client.Identity

Available Methods

Method	HTTP Equivalent	Description
ListIdentities	GET /identity/identities	List identities with optional filters
CreateIdentity	POST /identity/identities	Create a new identity for verification
GetIdentity	GET /identity/identities/{id}	Get an identity by ID
UpdateIdentity	PATCH /identity/identities/{id}	Update identity details

CreateIdentity

Go

identity, err := client.Identity.CreateIdentity(ctx, &paxos.CreateIdentityRequest{
    PersonDetails: &paxos.PersonDetails{
        FirstName:   "Jane",
        LastName:    "Doe",
        DateOfBirth: "1990-01-15",
    },
})
if err != nil {
    log.Fatal(err)
}
fmt.Printf("Created identity: %s (status: %s)\n", identity.ID, identity.SummaryStatus)

GetIdentity

Go

identity, err := client.Identity.GetIdentity(ctx, "identity_123")

ListIdentities

Go

iter := client.Identity.ListIdentities(ctx, &paxos.ListIdentitiesRequest{Limit: 50})
for iter.Next() {
    id := iter.Current()
    fmt.Printf("%s: %s %s (%s)\n", id.ID, id.PersonDetails.FirstName, id.PersonDetails.LastName, id.SummaryStatus)
}

In Sandbox, use client.Sandbox.SetIdentityStatus() to approve identities without real verification. See the Sandbox Guide.

For the full REST API documentation, see the Identity API Reference.