For a complete page index, fetch https://docs.transak.com/llms.txt

# Onboard User (Auth Reliance)

POST https://api-gateway-stg.transak.com/api/v2/user/onboard

The **Onboard User** API is used to create or fetch a user. This API is applicable only for [**Auth Reliance Flows**](/features/auth-reliance).


Pass the authenticated user's identifier in `x-user-identifier` and the partner access token in
`x-access-token`.

| Scenario | Behavior |
| --- | --- |
| New user | Creates the user and returns the KYC status. |
| Existing user | Returns the existing user details and KYC status. |

Reference: https://docs.transak.com/api/whitelabel/user/onboard-user-auth-reliance

## OpenAPI Specification

```yaml
openapi: 3.1.0
info:
  title: whitelabel-api
  version: 1.0.0
paths:
  /api/v2/user/onboard:
    post:
      operationId: onboard-user-auth-reliance
      summary: Onboard User (Auth Reliance)
      description: >-
        The **Onboard User** API is used to create or fetch a user. This API is
        applicable only for [**Auth Reliance Flows**](/features/auth-reliance).



        Pass the authenticated user's identifier in `x-user-identifier` and the
        partner access token in

        `x-access-token`.


        | Scenario | Behavior |

        | --- | --- |

        | New user | Creates the user and returns the KYC status. |

        | Existing user | Returns the existing user details and KYC status. |
      tags:
        - subpackage_user
      parameters:
        - name: x-user-identifier
          in: header
          description: >-
            Your authenticated user Email Id address.


            Note: This is applicable only for [Auth Reliance
            Flows](/features/auth-reliance)
          required: true
          schema:
            type: string
        - name: x-access-token
          in: header
          description: >
            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)
          required: true
          schema:
            type: string
      responses:
        '200':
          description: 200 - Success
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/User_onboard-user-auth-reliance_Response_200
        '401':
          description: 401 - Unauthorized
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/Onboard-user-auth-relianceRequestUnauthorizedError
        '500':
          description: 500 - Internal Server Error
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/Onboard-user-auth-relianceRequestInternalServerError
servers:
  - url: https://api-gateway-stg.transak.com
components:
  schemas:
    ApiV2UserOnboardPostResponsesContentApplicationJsonSchemaDataKyc:
      type: object
      properties:
        status:
          type: string
        type:
          type: string
      required:
        - status
        - type
      title: ApiV2UserOnboardPostResponsesContentApplicationJsonSchemaDataKyc
    ApiV2UserOnboardPostResponsesContentApplicationJsonSchemaData:
      type: object
      properties:
        partnerUserId:
          type: string
        email:
          type: string
        status:
          type: string
        kyc:
          $ref: >-
            #/components/schemas/ApiV2UserOnboardPostResponsesContentApplicationJsonSchemaDataKyc
      required:
        - partnerUserId
        - email
        - status
        - kyc
      title: ApiV2UserOnboardPostResponsesContentApplicationJsonSchemaData
    User_onboard-user-auth-reliance_Response_200:
      type: object
      properties:
        data:
          $ref: >-
            #/components/schemas/ApiV2UserOnboardPostResponsesContentApplicationJsonSchemaData
      required:
        - data
      title: User_onboard-user-auth-reliance_Response_200
    ApiV2UserOnboardPostResponsesContentApplicationJsonSchemaError:
      type: object
      properties:
        statusCode:
          type: integer
        message:
          type: string
      required:
        - statusCode
        - message
      title: ApiV2UserOnboardPostResponsesContentApplicationJsonSchemaError
    Onboard-user-auth-relianceRequestUnauthorizedError:
      type: object
      properties:
        error:
          $ref: >-
            #/components/schemas/ApiV2UserOnboardPostResponsesContentApplicationJsonSchemaError
      required:
        - error
      title: Onboard-user-auth-relianceRequestUnauthorizedError
    Onboard-user-auth-relianceRequestInternalServerError:
      type: object
      properties:
        error:
          $ref: >-
            #/components/schemas/ApiV2UserOnboardPostResponsesContentApplicationJsonSchemaError
      required:
        - error
      title: Onboard-user-auth-relianceRequestInternalServerError

```

## SDK Code Examples

```python Success Existing User
import requests

url = "https://api-gateway-stg.transak.com/api/v2/user/onboard"

headers = {
    "x-user-identifier": "test@gmail.com",
    "x-access-token": ""
}

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

print(response.json())
```

```javascript Success Existing User
const url = 'https://api-gateway-stg.transak.com/api/v2/user/onboard';
const options = {
  method: 'POST',
  headers: {'x-user-identifier': 'test@gmail.com', 'x-access-token': ''}
};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}
```

```go Success Existing User
package main

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

func main() {

	url := "https://api-gateway-stg.transak.com/api/v2/user/onboard"

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

	req.Header.Add("x-user-identifier", "test@gmail.com")
	req.Header.Add("x-access-token", "")

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

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

	fmt.Println(res)
	fmt.Println(string(body))

}
```

```ruby Success Existing User
require 'uri'
require 'net/http'

url = URI("https://api-gateway-stg.transak.com/api/v2/user/onboard")

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

request = Net::HTTP::Post.new(url)
request["x-user-identifier"] = 'test@gmail.com'
request["x-access-token"] = ''

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

```java Success Existing User
import com.mashape.unirest.http.HttpResponse;
import com.mashape.unirest.http.Unirest;

HttpResponse<String> response = Unirest.post("https://api-gateway-stg.transak.com/api/v2/user/onboard")
  .header("x-user-identifier", "test@gmail.com")
  .header("x-access-token", "")
  .asString();
```

```php Success Existing User
<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('POST', 'https://api-gateway-stg.transak.com/api/v2/user/onboard', [
  'headers' => [
    'x-access-token' => '',
    'x-user-identifier' => 'test@gmail.com',
  ],
]);

echo $response->getBody();
```

```csharp Success Existing User
using RestSharp;

var client = new RestClient("https://api-gateway-stg.transak.com/api/v2/user/onboard");
var request = new RestRequest(Method.POST);
request.AddHeader("x-user-identifier", "test@gmail.com");
request.AddHeader("x-access-token", "");
IRestResponse response = client.Execute(request);
```

```swift Success Existing User
import Foundation

let headers = [
  "x-user-identifier": "test@gmail.com",
  "x-access-token": ""
]

let request = NSMutableURLRequest(url: NSURL(string: "https://api-gateway-stg.transak.com/api/v2/user/onboard")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "POST"
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()
```

```python Success New User
import requests

url = "https://api-gateway-stg.transak.com/api/v2/user/onboard"

headers = {
    "x-user-identifier": "test@gmail.com",
    "x-access-token": ""
}

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

print(response.json())
```

```javascript Success New User
const url = 'https://api-gateway-stg.transak.com/api/v2/user/onboard';
const options = {
  method: 'POST',
  headers: {'x-user-identifier': 'test@gmail.com', 'x-access-token': ''}
};

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/onboard"

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

	req.Header.Add("x-user-identifier", "test@gmail.com")
	req.Header.Add("x-access-token", "")

	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/onboard")

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

request = Net::HTTP::Post.new(url)
request["x-user-identifier"] = 'test@gmail.com'
request["x-access-token"] = ''

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<String> response = Unirest.post("https://api-gateway-stg.transak.com/api/v2/user/onboard")
  .header("x-user-identifier", "test@gmail.com")
  .header("x-access-token", "")
  .asString();
```

```php Success New User
<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('POST', 'https://api-gateway-stg.transak.com/api/v2/user/onboard', [
  'headers' => [
    'x-access-token' => '',
    'x-user-identifier' => 'test@gmail.com',
  ],
]);

echo $response->getBody();
```

```csharp Success New User
using RestSharp;

var client = new RestClient("https://api-gateway-stg.transak.com/api/v2/user/onboard");
var request = new RestRequest(Method.POST);
request.AddHeader("x-user-identifier", "test@gmail.com");
request.AddHeader("x-access-token", "");
IRestResponse response = client.Execute(request);
```

```swift Success New User
import Foundation

let headers = [
  "x-user-identifier": "test@gmail.com",
  "x-access-token": ""
]

let request = NSMutableURLRequest(url: NSURL(string: "https://api-gateway-stg.transak.com/api/v2/user/onboard")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "POST"
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()
```