Complete a social session

curl --request POST \
  --url https://api-sandbox.circle.com/v1/accounts/auth/sessions \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "idempotencyKey": "8a2b3c4d-5e6f-4a7b-9c8d-0e1f2a3b4c5d",
  "loginRequestId": "3f9a6c1e-2b7d-4e8a-9c0f-5d1e2a3b4c5d",
  "idToken": "eyJhbGciOiJSUzI1NiIsImtpZCI6IjEifQ.eyJpc3MiOiJodHRwczovL2FjY291bnRzLmdvb2dsZS5jb20ifQ.c2lnbmF0dXJl",
  "clientEntityId": "a3f1b2c4-d5e6-7890-abcd-ef1234567890"
}
'

import requests

url = "https://api-sandbox.circle.com/v1/accounts/auth/sessions"

payload = {
    "idempotencyKey": "8a2b3c4d-5e6f-4a7b-9c8d-0e1f2a3b4c5d",
    "loginRequestId": "3f9a6c1e-2b7d-4e8a-9c0f-5d1e2a3b4c5d",
    "idToken": "eyJhbGciOiJSUzI1NiIsImtpZCI6IjEifQ.eyJpc3MiOiJodHRwczovL2FjY291bnRzLmdvb2dsZS5jb20ifQ.c2lnbmF0dXJl",
    "clientEntityId": "a3f1b2c4-d5e6-7890-abcd-ef1234567890"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    idempotencyKey: '8a2b3c4d-5e6f-4a7b-9c8d-0e1f2a3b4c5d',
    loginRequestId: '3f9a6c1e-2b7d-4e8a-9c0f-5d1e2a3b4c5d',
    idToken: 'eyJhbGciOiJSUzI1NiIsImtpZCI6IjEifQ.eyJpc3MiOiJodHRwczovL2FjY291bnRzLmdvb2dsZS5jb20ifQ.c2lnbmF0dXJl',
    clientEntityId: 'a3f1b2c4-d5e6-7890-abcd-ef1234567890'
  })
};

fetch('https://api-sandbox.circle.com/v1/accounts/auth/sessions', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api-sandbox.circle.com/v1/accounts/auth/sessions",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'idempotencyKey' => '8a2b3c4d-5e6f-4a7b-9c8d-0e1f2a3b4c5d',
    'loginRequestId' => '3f9a6c1e-2b7d-4e8a-9c0f-5d1e2a3b4c5d',
    'idToken' => 'eyJhbGciOiJSUzI1NiIsImtpZCI6IjEifQ.eyJpc3MiOiJodHRwczovL2FjY291bnRzLmdvb2dsZS5jb20ifQ.c2lnbmF0dXJl',
    'clientEntityId' => 'a3f1b2c4-d5e6-7890-abcd-ef1234567890'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api-sandbox.circle.com/v1/accounts/auth/sessions"

	payload := strings.NewReader("{\n  \"idempotencyKey\": \"8a2b3c4d-5e6f-4a7b-9c8d-0e1f2a3b4c5d\",\n  \"loginRequestId\": \"3f9a6c1e-2b7d-4e8a-9c0f-5d1e2a3b4c5d\",\n  \"idToken\": \"eyJhbGciOiJSUzI1NiIsImtpZCI6IjEifQ.eyJpc3MiOiJodHRwczovL2FjY291bnRzLmdvb2dsZS5jb20ifQ.c2lnbmF0dXJl\",\n  \"clientEntityId\": \"a3f1b2c4-d5e6-7890-abcd-ef1234567890\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api-sandbox.circle.com/v1/accounts/auth/sessions")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"idempotencyKey\": \"8a2b3c4d-5e6f-4a7b-9c8d-0e1f2a3b4c5d\",\n  \"loginRequestId\": \"3f9a6c1e-2b7d-4e8a-9c0f-5d1e2a3b4c5d\",\n  \"idToken\": \"eyJhbGciOiJSUzI1NiIsImtpZCI6IjEifQ.eyJpc3MiOiJodHRwczovL2FjY291bnRzLmdvb2dsZS5jb20ifQ.c2lnbmF0dXJl\",\n  \"clientEntityId\": \"a3f1b2c4-d5e6-7890-abcd-ef1234567890\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api-sandbox.circle.com/v1/accounts/auth/sessions")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"idempotencyKey\": \"8a2b3c4d-5e6f-4a7b-9c8d-0e1f2a3b4c5d\",\n  \"loginRequestId\": \"3f9a6c1e-2b7d-4e8a-9c0f-5d1e2a3b4c5d\",\n  \"idToken\": \"eyJhbGciOiJSUzI1NiIsImtpZCI6IjEifQ.eyJpc3MiOiJodHRwczovL2FjY291bnRzLmdvb2dsZS5jb20ifQ.c2lnbmF0dXJl\",\n  \"clientEntityId\": \"a3f1b2c4-d5e6-7890-abcd-ef1234567890\"\n}"

response = http.request(request)
puts response.read_body

{
  "data": {
    "registrationHandle": "Yk3vQ9xR2mT7nL4pW8sZ1cF6hJ0aD5eG3uB9iK2oN7q",
    "clientEntityId": "a3f1b2c4-d5e6-7890-abcd-ef1234567890",
    "expiresAt": 1759766760000
  }
}

{
  "code": 2,
  "message": "API parameter invalid.",
  "externalMessage": "The provided amount exceeds the maximum allowed.",
  "errors": [
    {
      "error": "invalid_value",
      "message": "The operation and assetType combination is invalid.",
      "location": "assetType"
    }
  ]
}

{
  "code": 4,
  "message": "Unauthorized."
}

{
  "code": 2,
  "message": "API parameter invalid.",
  "externalMessage": "The provided amount exceeds the maximum allowed.",
  "errors": [
    {
      "error": "invalid_value",
      "message": "The operation and assetType combination is invalid.",
      "location": "assetType"
    }
  ]
}

{
  "code": 2,
  "message": "API parameter invalid.",
  "externalMessage": "The provided amount exceeds the maximum allowed.",
  "errors": [
    {
      "error": "invalid_value",
      "message": "The operation and assetType combination is invalid.",
      "location": "assetType"
    }
  ]
}

{
  "code": 2,
  "message": "API parameter invalid.",
  "externalMessage": "The provided amount exceeds the maximum allowed.",
  "errors": [
    {
      "error": "invalid_value",
      "message": "The operation and assetType combination is invalid.",
      "location": "assetType"
    }
  ]
}

{
  "code": 2,
  "message": "API parameter invalid.",
  "externalMessage": "The provided amount exceeds the maximum allowed.",
  "errors": [
    {
      "error": "invalid_value",
      "message": "The operation and assetType combination is invalid.",
      "location": "assetType"
    }
  ]
}

{
  "code": -1,
  "message": "Something went wrong. errId: 1f0b0c455e40f753f07b4f0ae6abd4b4"
}

Complete a social session

Non-custodial accounts are available in sandbox only. Production non-custodial accounts are on the roadmap.

Verifies the identity provider’s ID token against a prepared login and links the signed-in identity to the end customer named by clientEntityId. Returns a single-use registrationHandle for POST /v1/accounts/auth/deviceKeyRegistration.

Before you go live, register your application’s Google client IDs in Circle Hub (Digital Asset Accounts settings > Social login). In staging and production, the ID token’s audience must be one of them.

This call doesn’t create an account or a wallet, and doesn’t need a device signature. The Digital Asset Accounts SDK builds the request on the device. Your backend relay adds your API key and forwards it.

POST

accounts

auth

sessions

Complete a social session

curl --request POST \
  --url https://api-sandbox.circle.com/v1/accounts/auth/sessions \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "idempotencyKey": "8a2b3c4d-5e6f-4a7b-9c8d-0e1f2a3b4c5d",
  "loginRequestId": "3f9a6c1e-2b7d-4e8a-9c0f-5d1e2a3b4c5d",
  "idToken": "eyJhbGciOiJSUzI1NiIsImtpZCI6IjEifQ.eyJpc3MiOiJodHRwczovL2FjY291bnRzLmdvb2dsZS5jb20ifQ.c2lnbmF0dXJl",
  "clientEntityId": "a3f1b2c4-d5e6-7890-abcd-ef1234567890"
}
'

import requests

url = "https://api-sandbox.circle.com/v1/accounts/auth/sessions"

payload = {
    "idempotencyKey": "8a2b3c4d-5e6f-4a7b-9c8d-0e1f2a3b4c5d",
    "loginRequestId": "3f9a6c1e-2b7d-4e8a-9c0f-5d1e2a3b4c5d",
    "idToken": "eyJhbGciOiJSUzI1NiIsImtpZCI6IjEifQ.eyJpc3MiOiJodHRwczovL2FjY291bnRzLmdvb2dsZS5jb20ifQ.c2lnbmF0dXJl",
    "clientEntityId": "a3f1b2c4-d5e6-7890-abcd-ef1234567890"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    idempotencyKey: '8a2b3c4d-5e6f-4a7b-9c8d-0e1f2a3b4c5d',
    loginRequestId: '3f9a6c1e-2b7d-4e8a-9c0f-5d1e2a3b4c5d',
    idToken: 'eyJhbGciOiJSUzI1NiIsImtpZCI6IjEifQ.eyJpc3MiOiJodHRwczovL2FjY291bnRzLmdvb2dsZS5jb20ifQ.c2lnbmF0dXJl',
    clientEntityId: 'a3f1b2c4-d5e6-7890-abcd-ef1234567890'
  })
};

fetch('https://api-sandbox.circle.com/v1/accounts/auth/sessions', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api-sandbox.circle.com/v1/accounts/auth/sessions",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'idempotencyKey' => '8a2b3c4d-5e6f-4a7b-9c8d-0e1f2a3b4c5d',
    'loginRequestId' => '3f9a6c1e-2b7d-4e8a-9c0f-5d1e2a3b4c5d',
    'idToken' => 'eyJhbGciOiJSUzI1NiIsImtpZCI6IjEifQ.eyJpc3MiOiJodHRwczovL2FjY291bnRzLmdvb2dsZS5jb20ifQ.c2lnbmF0dXJl',
    'clientEntityId' => 'a3f1b2c4-d5e6-7890-abcd-ef1234567890'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api-sandbox.circle.com/v1/accounts/auth/sessions"

	payload := strings.NewReader("{\n  \"idempotencyKey\": \"8a2b3c4d-5e6f-4a7b-9c8d-0e1f2a3b4c5d\",\n  \"loginRequestId\": \"3f9a6c1e-2b7d-4e8a-9c0f-5d1e2a3b4c5d\",\n  \"idToken\": \"eyJhbGciOiJSUzI1NiIsImtpZCI6IjEifQ.eyJpc3MiOiJodHRwczovL2FjY291bnRzLmdvb2dsZS5jb20ifQ.c2lnbmF0dXJl\",\n  \"clientEntityId\": \"a3f1b2c4-d5e6-7890-abcd-ef1234567890\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api-sandbox.circle.com/v1/accounts/auth/sessions")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"idempotencyKey\": \"8a2b3c4d-5e6f-4a7b-9c8d-0e1f2a3b4c5d\",\n  \"loginRequestId\": \"3f9a6c1e-2b7d-4e8a-9c0f-5d1e2a3b4c5d\",\n  \"idToken\": \"eyJhbGciOiJSUzI1NiIsImtpZCI6IjEifQ.eyJpc3MiOiJodHRwczovL2FjY291bnRzLmdvb2dsZS5jb20ifQ.c2lnbmF0dXJl\",\n  \"clientEntityId\": \"a3f1b2c4-d5e6-7890-abcd-ef1234567890\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api-sandbox.circle.com/v1/accounts/auth/sessions")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"idempotencyKey\": \"8a2b3c4d-5e6f-4a7b-9c8d-0e1f2a3b4c5d\",\n  \"loginRequestId\": \"3f9a6c1e-2b7d-4e8a-9c0f-5d1e2a3b4c5d\",\n  \"idToken\": \"eyJhbGciOiJSUzI1NiIsImtpZCI6IjEifQ.eyJpc3MiOiJodHRwczovL2FjY291bnRzLmdvb2dsZS5jb20ifQ.c2lnbmF0dXJl\",\n  \"clientEntityId\": \"a3f1b2c4-d5e6-7890-abcd-ef1234567890\"\n}"

response = http.request(request)
puts response.read_body

{
  "data": {
    "registrationHandle": "Yk3vQ9xR2mT7nL4pW8sZ1cF6hJ0aD5eG3uB9iK2oN7q",
    "clientEntityId": "a3f1b2c4-d5e6-7890-abcd-ef1234567890",
    "expiresAt": 1759766760000
  }
}

{
  "code": 2,
  "message": "API parameter invalid.",
  "externalMessage": "The provided amount exceeds the maximum allowed.",
  "errors": [
    {
      "error": "invalid_value",
      "message": "The operation and assetType combination is invalid.",
      "location": "assetType"
    }
  ]
}

{
  "code": 4,
  "message": "Unauthorized."
}

{
  "code": 2,
  "message": "API parameter invalid.",
  "externalMessage": "The provided amount exceeds the maximum allowed.",
  "errors": [
    {
      "error": "invalid_value",
      "message": "The operation and assetType combination is invalid.",
      "location": "assetType"
    }
  ]
}

{
  "code": 2,
  "message": "API parameter invalid.",
  "externalMessage": "The provided amount exceeds the maximum allowed.",
  "errors": [
    {
      "error": "invalid_value",
      "message": "The operation and assetType combination is invalid.",
      "location": "assetType"
    }
  ]
}

{
  "code": 2,
  "message": "API parameter invalid.",
  "externalMessage": "The provided amount exceeds the maximum allowed.",
  "errors": [
    {
      "error": "invalid_value",
      "message": "The operation and assetType combination is invalid.",
      "location": "assetType"
    }
  ]
}

{
  "code": 2,
  "message": "API parameter invalid.",
  "externalMessage": "The provided amount exceeds the maximum allowed.",
  "errors": [
    {
      "error": "invalid_value",
      "message": "The operation and assetType combination is invalid.",
      "location": "assetType"
    }
  ]
}

{
  "code": -1,
  "message": "Something went wrong. errId: 1f0b0c455e40f753f07b4f0ae6abd4b4"
}

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json

idempotencyKey

string<uuid>

required

Universally unique identifier (UUID v4) idempotency key. This key is utilized to ensure exactly-once execution of mutating requests.

Example:

"ba943ff1-ca16-49b2-ba55-1057e70ca5c7"

The loginRequestId returned by POST /v1/accounts/auth/loginRequests.

Example:

"3f9a6c1e-2b7d-4e8a-9c0f-5d1e2a3b4c5d"

idToken

string

required

The ID token your application received from the identity provider. It must carry the oidcNonce returned when the login was prepared.

Maximum string length: 8192

Example:

"eyJhbGciOiJSUzI1NiIsImtpZCI6IjEifQ.eyJpc3MiOiJodHRwczovL2FjY291bnRzLmdvb2dsZS5jb20ifQ.c2lnbmF0dXJl"

clientEntityId

string<uuid>

required

The end customer the signed-in end user acts for. Use the clientEntityId returned when you created the end customer with Create a partner client (POST /v1/partner/clients). It must belong to your entity.

Circle permanently links the signed-in identity to this clientEntityId, and you can't change the link later. Read the value from your own backend session for the signed-in user. Never take it from user input.

Example:

"a3f1b2c4-d5e6-7890-abcd-ef1234567890"

Response

Successfully verified the social login.

data

object

required

A verified social session, ready for device registration.

Show child attributes

Accounts

First-party bank operations

First-party crypto operations

Third-party crypto operations

Cross-currency API

Notifications

Security

Complete a social session

Authorizations

Body

Response