Skip to main content
GET
/
onboarding
/
api
/
v1
/
users
/
{user_id}
Get User Details
curl --request GET \
  --url https://api.carbnconnect.com/onboarding/api/v1/users/{user_id} \
  --header 'x-api-key: <api-key>'
import requests

url = "https://api.carbnconnect.com/onboarding/api/v1/users/{user_id}"

headers = {"x-api-key": "<api-key>"}

response = requests.get(url, headers=headers)

print(response.text)
const options = {method: 'GET', headers: {'x-api-key': '<api-key>'}};

fetch('https://api.carbnconnect.com/onboarding/api/v1/users/{user_id}', 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.carbnconnect.com/onboarding/api/v1/users/{user_id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "x-api-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 := "https://api.carbnconnect.com/onboarding/api/v1/users/{user_id}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("x-api-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.get("https://api.carbnconnect.com/onboarding/api/v1/users/{user_id}")
  .header("x-api-key", "<api-key>")
  .asString();
require 'uri'
require 'net/http'

url = URI("https://api.carbnconnect.com/onboarding/api/v1/users/{user_id}")

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

request = Net::HTTP::Get.new(url)
request["x-api-key"] = '<api-key>'

response = http.request(request)
puts response.read_body
{
  "id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
  "status": "under_review",
  "documents": [
    {
      "name": "national_id",
      "type": "identity_front"
    },
    {
      "name": "national_id",
      "type": "identity_back"
    },
    {
      "name": "steuer_id",
      "type": "tax_document"
    }
  ],
  "address": {
    "line1": "123 Main Street",
    "line2": null,
    "city": "City Name",
    "country": "DEU",
    "region": null,
    "sub_division": "ST",
    "postal_code": "12345"
  },
  "first_name": "John",
  "last_name": "Doe",
  "email_address": "user@example.com",
  "phone_number": "+1XXXXXXXXXX",
  "date_of_birth": "YYYY-MM-DD",
  "rejection_reasons": null,
  "requirements": null
}

Authorizations

​
x-api-key
string
header
required

API key for authentication. Must be included in the x-api-key header.

Path Parameters

​
user_id
string<uuid>
required

The unique identifier of the user

Response

User details retrieved successfully

​
id
string<uuid>

Unique user identifier

Example:

"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"

​
status
enum<string>

Current user status. under_review: Initial status when user is created (default). active: User has been approved and verified. paused: User account is temporarily paused. rejected: User has been rejected during KYC process. offboarded: User has been removed/offboarded from the system. incomplete: User profile is missing required information.

Available options:
under_review,
active,
rejected,
offboarded,
incomplete
Example:

"under_review"

​
documents
object[]

List of uploaded documents (both identity and supporting documents)

Example:
[
  {
    "name": "national_id",
    "type": "identity_front"
  },
  {
    "name": "national_id",
    "type": "identity_back"
  },
  {
    "name": "steuer_id",
    "type": "tax_document"
  }
]
​
address
object
​
first_name
string

User's first name

Example:

"John"

​
last_name
string

User's last name

Example:

"Doe"

​
email_address
string<email>

User's email address

Example:

"user@example.com"

​
phone_number
string

User's phone number

Example:

"+1XXXXXXXXXX"

​
date_of_birth
string<date>

User's date of birth

Example:

"YYYY-MM-DD"

​
rejection_reasons
object[] | null

Array of rejection reason objects (only populated for rejected users, null otherwise). Each object contains customer-facing reason, timestamp, and internal developer reason.

Example:

null

​
requirements
string[] | null

List of missing requirements for incomplete users (null when no requirements are missing)

Example:

null