> For a complete page index, fetch https://docs.transak.com/llms.txt # Get User Details GET https://api-gateway-stg.transak.com/api/v2/user The **Get User Details** is an **authenticated API** call that allows you to fetch the user details of the authenticated user. Reference: https://docs.transak.com/api/whitelabel/user/get-user-details ## Request ### Query parameters - `apiKey` (string, required) — Your API Key from Transak Dashboard ### Headers - `x-user-ip` (string, required) — End user's originating IP. More details [here](/guides/mandatory-security-changes#user-ip-header-in-apis) - `x-api-key` (string, required) — Partner API Key present in Transak Dashboard. - `authorization` (string, optional) — Authorization token is the accessToken received from the API -` api/v2/auth/verify` Note: This is not applicable for [Auth Reliance Flows](/features/auth-reliance) - `x-user-identifier` (string, optional) — Your authenticated user Email Id address. Note: This is applicable only for [Auth Reliance Flows](/features/auth-reliance) - `x-access-token` (string, optional) — Your Partner Access Token. Please refer [here](/guides/how-to-create-partner-access-token) for a tutorial on generating your access token. Note: This is applicable only for [Auth Reliance Flows](/features/auth-reliance) ## Response ### 200 200 - Success New User - `data` (ApiV2UserGetResponsesContentApplicationJsonSchemaData, required) ## Errors ### 400 Bad Request Error 400 - Session Expired - `error` (ApiV2UserGetResponsesContentApplicationJsonSchemaError, required) ### 401 Unauthorized Error 401 - Unauthorized - `error` (ApiV2UserGetResponsesContentApplicationJsonSchemaError, required) ### 404 Not Found Error 404 - User Not Found - `error` (ApiV2UserGetResponsesContentApplicationJsonSchemaError, required) ### 500 Internal Server Error 500 - Internal Server Error - `error` (ApiV2UserGetResponsesContentApplicationJsonSchemaError, required) ## Types ### ApiV2UserGetResponsesContentApplicationJsonSchemaData ### ApiV2UserGetResponsesContentApplicationJsonSchemaError - `statusCode` (integer, required) - `message` (string, required) ### ApiV2UserGetResponsesContentApplicationJsonSchemaData0 - `partnerUserId` (string, required) - `firstName` (string, required) - `lastName` (string, required) - `email` (string, required) - `mobileNumber` (string, required) - `status` (string, required) - `dob` (string, required) - `kyc` (ApiV2UserGetResponsesContentApplicationJsonSchemaDataOneOf0Kyc, required) - `address` (ApiV2UserGetResponsesContentApplicationJsonSchemaDataOneOf0Address, required) ### ApiV2UserGetResponsesContentApplicationJsonSchemaData1 - `partnerUserId` (string, required) - `email` (string, required) - `status` (string, required) - `kyc` (ApiV2UserGetResponsesContentApplicationJsonSchemaDataOneOf1Kyc, required) ### ApiV2UserGetResponsesContentApplicationJsonSchemaDataOneOf0Kyc - `status` (string, required) - `type` (string, required) ### ApiV2UserGetResponsesContentApplicationJsonSchemaDataOneOf0Address - `addressLine1` (string, required) - `addressLine2` (string, required) - `state` (string, required) - `city` (string, required) - `postCode` (string, required) - `country` (string, required) - `countryCode` (string, required) ### ApiV2UserGetResponsesContentApplicationJsonSchemaDataOneOf1Kyc - `status` (string, required) - `type` (string, required) ## Examples ### Success New User **Response** ```json { "data": { "address": { "addressLine1": "170 Rue du Faubourg Saint-Denis, Paris", "addressLine2": "", "city": "Paris", "country": "France", "countryCode": "FR", "postCode": "75010", "state": "Paris" }, "dob": "2000-01-01T00:00:00.000Z", "email": "test@gmail.com", "firstName": "Doe", "kyc": { "status": "APPROVED", "type": "STANDARD" }, "lastName": "Jane", "mobileNumber": "+33791112345", "partnerUserId": "269b0f29-b5ec-42bb-acea-2b89c15b2505", "status": "ACTIVE" } } ``` **SDK Code** ```python Success New User import requests url = "https://api-gateway-stg.transak.com/api/v2/user" querystring = {"apiKey":""} headers = { "x-api-key": "", "x-user-ip": "" } response = requests.get(url, headers=headers, params=querystring) print(response.json()) ``` ```javascript Success New User const url = 'https://api-gateway-stg.transak.com/api/v2/user?apiKey='; const options = {method: 'GET', headers: {'x-api-key': '', 'x-user-ip': ''}}; try { const response = await fetch(url, options); const data = await response.json(); console.log(data); } catch (error) { console.error(error); } ``` ```go Success New User package main import ( "fmt" "net/http" "io" ) func main() { url := "https://api-gateway-stg.transak.com/api/v2/user?apiKey=" req, _ := http.NewRequest("GET", url, nil) req.Header.Add("x-api-key", "") req.Header.Add("x-user-ip", "") res, _ := http.DefaultClient.Do(req) defer res.Body.Close() body, _ := io.ReadAll(res.Body) fmt.Println(res) fmt.Println(string(body)) } ``` ```ruby Success New User require 'uri' require 'net/http' url = URI("https://api-gateway-stg.transak.com/api/v2/user?apiKey=") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true request = Net::HTTP::Get.new(url) request["x-api-key"] = '' request["x-user-ip"] = '' response = http.request(request) puts response.read_body ``` ```java Success New User import com.mashape.unirest.http.HttpResponse; import com.mashape.unirest.http.Unirest; HttpResponse response = Unirest.get("https://api-gateway-stg.transak.com/api/v2/user?apiKey=") .header("x-api-key", "") .header("x-user-ip", "") .asString(); ``` ```php Success New User request('GET', 'https://api-gateway-stg.transak.com/api/v2/user?apiKey=', [ 'headers' => [ 'x-api-key' => '', 'x-user-ip' => '', ], ]); echo $response->getBody(); ``` ```csharp Success New User using RestSharp; var client = new RestClient("https://api-gateway-stg.transak.com/api/v2/user?apiKey="); var request = new RestRequest(Method.GET); request.AddHeader("x-api-key", ""); request.AddHeader("x-user-ip", ""); IRestResponse response = client.Execute(request); ``` ```swift Success New User import Foundation let headers = [ "x-api-key": "", "x-user-ip": "" ] let request = NSMutableURLRequest(url: NSURL(string: "https://api-gateway-stg.transak.com/api/v2/user?apiKey=")! as URL, cachePolicy: .useProtocolCachePolicy, timeoutInterval: 10.0) request.httpMethod = "GET" request.allHTTPHeaderFields = headers let session = URLSession.shared let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in if (error != nil) { print(error as Any) } else { let httpResponse = response as? HTTPURLResponse print(httpResponse) } }) dataTask.resume() ``` ### Success User (Auth Reliance) **Response** ```json { "data": { "email": "test@gmail.com", "kyc": { "status": "APPROVED", "type": "STANDARD" }, "partnerUserId": "2e0dqwe4a-f0cc-46f8-b965-231d9bccb3da", "status": "ACTIVE" } } ``` **SDK Code** ```python Success User (Auth Reliance) import requests url = "https://api-gateway-stg.transak.com/api/v2/user" querystring = {"apiKey":""} headers = { "x-api-key": "", "x-user-ip": "" } response = requests.get(url, headers=headers, params=querystring) print(response.json()) ``` ```javascript Success User (Auth Reliance) const url = 'https://api-gateway-stg.transak.com/api/v2/user?apiKey='; const options = {method: 'GET', headers: {'x-api-key': '', 'x-user-ip': ''}}; try { const response = await fetch(url, options); const data = await response.json(); console.log(data); } catch (error) { console.error(error); } ``` ```go Success User (Auth Reliance) package main import ( "fmt" "net/http" "io" ) func main() { url := "https://api-gateway-stg.transak.com/api/v2/user?apiKey=" req, _ := http.NewRequest("GET", url, nil) req.Header.Add("x-api-key", "") req.Header.Add("x-user-ip", "") res, _ := http.DefaultClient.Do(req) defer res.Body.Close() body, _ := io.ReadAll(res.Body) fmt.Println(res) fmt.Println(string(body)) } ``` ```ruby Success User (Auth Reliance) require 'uri' require 'net/http' url = URI("https://api-gateway-stg.transak.com/api/v2/user?apiKey=") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true request = Net::HTTP::Get.new(url) request["x-api-key"] = '' request["x-user-ip"] = '' response = http.request(request) puts response.read_body ``` ```java Success User (Auth Reliance) import com.mashape.unirest.http.HttpResponse; import com.mashape.unirest.http.Unirest; HttpResponse response = Unirest.get("https://api-gateway-stg.transak.com/api/v2/user?apiKey=") .header("x-api-key", "") .header("x-user-ip", "") .asString(); ``` ```php Success User (Auth Reliance) request('GET', 'https://api-gateway-stg.transak.com/api/v2/user?apiKey=', [ 'headers' => [ 'x-api-key' => '', 'x-user-ip' => '', ], ]); echo $response->getBody(); ``` ```csharp Success User (Auth Reliance) using RestSharp; var client = new RestClient("https://api-gateway-stg.transak.com/api/v2/user?apiKey="); var request = new RestRequest(Method.GET); request.AddHeader("x-api-key", ""); request.AddHeader("x-user-ip", ""); IRestResponse response = client.Execute(request); ``` ```swift Success User (Auth Reliance) import Foundation let headers = [ "x-api-key": "", "x-user-ip": "" ] let request = NSMutableURLRequest(url: NSURL(string: "https://api-gateway-stg.transak.com/api/v2/user?apiKey=")! as URL, cachePolicy: .useProtocolCachePolicy, timeoutInterval: 10.0) request.httpMethod = "GET" request.allHTTPHeaderFields = headers let session = URLSession.shared let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in if (error != nil) { print(error as Any) } else { let httpResponse = response as? HTTPURLResponse print(httpResponse) } }) dataTask.resume() ```