Complete Onboarding

cURL

curl --request POST \
  --url http://localhost:8080/users/{user_id}/complete_onboarding \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "address": {
    "city": "Bengaluru",
    "country": "IN",
    "line1": "123, MG Road",
    "pincode": "560001",
    "state": "Karnataka",
    "raw": "<string>",
    "line2": "Flat 4B, Sunrise Apartments"
  },
  "bank_details": {
    "account_number": "50123456789",
    "ifsc_code": "HDFC0000001"
  },
  "dob": "2000-01-15",
  "first_name": "<string>",
  "last_name": "<string>",
  "email": "<string>"
}
'

import requests

url = "http://localhost:8080/users/{user_id}/complete_onboarding"

payload = {
    "address": {
        "city": "Bengaluru",
        "country": "IN",
        "line1": "123, MG Road",
        "pincode": "560001",
        "state": "Karnataka",
        "raw": "<string>",
        "line2": "Flat 4B, Sunrise Apartments"
    },
    "bank_details": {
        "account_number": "50123456789",
        "ifsc_code": "HDFC0000001"
    },
    "dob": "2000-01-15",
    "first_name": "<string>",
    "last_name": "<string>",
    "email": "<string>"
}
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({
    address: {
      city: 'Bengaluru',
      country: 'IN',
      line1: '123, MG Road',
      pincode: '560001',
      state: 'Karnataka',
      raw: '<string>',
      line2: 'Flat 4B, Sunrise Apartments'
    },
    bank_details: {account_number: '50123456789', ifsc_code: 'HDFC0000001'},
    dob: '2000-01-15',
    first_name: '<string>',
    last_name: '<string>',
    email: '<string>'
  })
};

fetch('http://localhost:8080/users/{user_id}/complete_onboarding', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_PORT => "8080",
  CURLOPT_URL => "http://localhost:8080/users/{user_id}/complete_onboarding",
  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([
    'address' => [
        'city' => 'Bengaluru',
        'country' => 'IN',
        'line1' => '123, MG Road',
        'pincode' => '560001',
        'state' => 'Karnataka',
        'raw' => '<string>',
        'line2' => 'Flat 4B, Sunrise Apartments'
    ],
    'bank_details' => [
        'account_number' => '50123456789',
        'ifsc_code' => 'HDFC0000001'
    ],
    'dob' => '2000-01-15',
    'first_name' => '<string>',
    'last_name' => '<string>',
    'email' => '<string>'
  ]),
  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 := "http://localhost:8080/users/{user_id}/complete_onboarding"

	payload := strings.NewReader("{\n  \"address\": {\n    \"city\": \"Bengaluru\",\n    \"country\": \"IN\",\n    \"line1\": \"123, MG Road\",\n    \"pincode\": \"560001\",\n    \"state\": \"Karnataka\",\n    \"raw\": \"<string>\",\n    \"line2\": \"Flat 4B, Sunrise Apartments\"\n  },\n  \"bank_details\": {\n    \"account_number\": \"50123456789\",\n    \"ifsc_code\": \"HDFC0000001\"\n  },\n  \"dob\": \"2000-01-15\",\n  \"first_name\": \"<string>\",\n  \"last_name\": \"<string>\",\n  \"email\": \"<string>\"\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("http://localhost:8080/users/{user_id}/complete_onboarding")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"address\": {\n    \"city\": \"Bengaluru\",\n    \"country\": \"IN\",\n    \"line1\": \"123, MG Road\",\n    \"pincode\": \"560001\",\n    \"state\": \"Karnataka\",\n    \"raw\": \"<string>\",\n    \"line2\": \"Flat 4B, Sunrise Apartments\"\n  },\n  \"bank_details\": {\n    \"account_number\": \"50123456789\",\n    \"ifsc_code\": \"HDFC0000001\"\n  },\n  \"dob\": \"2000-01-15\",\n  \"first_name\": \"<string>\",\n  \"last_name\": \"<string>\",\n  \"email\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("http://localhost:8080/users/{user_id}/complete_onboarding")

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

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"address\": {\n    \"city\": \"Bengaluru\",\n    \"country\": \"IN\",\n    \"line1\": \"123, MG Road\",\n    \"pincode\": \"560001\",\n    \"state\": \"Karnataka\",\n    \"raw\": \"<string>\",\n    \"line2\": \"Flat 4B, Sunrise Apartments\"\n  },\n  \"bank_details\": {\n    \"account_number\": \"50123456789\",\n    \"ifsc_code\": \"HDFC0000001\"\n  },\n  \"dob\": \"2000-01-15\",\n  \"first_name\": \"<string>\",\n  \"last_name\": \"<string>\",\n  \"email\": \"<string>\"\n}"

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

{
  "access_token": "<string>",
  "user": {
    "created_at": "2026-01-15T12:34:56",
    "last_modified_at": "2026-01-15T12:34:56",
    "phone_country_code": "<string>",
    "phone_number": "<string>",
    "user_id": "012345678901",
    "address": {
      "city": "Bengaluru",
      "country": "IN",
      "line1": "123, MG Road",
      "pincode": "560001",
      "state": "Karnataka",
      "raw": "<string>",
      "line2": "Flat 4B, Sunrise Apartments"
    },
    "dob": "2000-01-15",
    "email": "<string>",
    "first_name": "<string>",
    "last_name": "<string>"
  }
}

POST

users

{user_id}

complete_onboarding

cURL

curl --request POST \
  --url http://localhost:8080/users/{user_id}/complete_onboarding \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "address": {
    "city": "Bengaluru",
    "country": "IN",
    "line1": "123, MG Road",
    "pincode": "560001",
    "state": "Karnataka",
    "raw": "<string>",
    "line2": "Flat 4B, Sunrise Apartments"
  },
  "bank_details": {
    "account_number": "50123456789",
    "ifsc_code": "HDFC0000001"
  },
  "dob": "2000-01-15",
  "first_name": "<string>",
  "last_name": "<string>",
  "email": "<string>"
}
'

import requests

url = "http://localhost:8080/users/{user_id}/complete_onboarding"

payload = {
    "address": {
        "city": "Bengaluru",
        "country": "IN",
        "line1": "123, MG Road",
        "pincode": "560001",
        "state": "Karnataka",
        "raw": "<string>",
        "line2": "Flat 4B, Sunrise Apartments"
    },
    "bank_details": {
        "account_number": "50123456789",
        "ifsc_code": "HDFC0000001"
    },
    "dob": "2000-01-15",
    "first_name": "<string>",
    "last_name": "<string>",
    "email": "<string>"
}
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({
    address: {
      city: 'Bengaluru',
      country: 'IN',
      line1: '123, MG Road',
      pincode: '560001',
      state: 'Karnataka',
      raw: '<string>',
      line2: 'Flat 4B, Sunrise Apartments'
    },
    bank_details: {account_number: '50123456789', ifsc_code: 'HDFC0000001'},
    dob: '2000-01-15',
    first_name: '<string>',
    last_name: '<string>',
    email: '<string>'
  })
};

fetch('http://localhost:8080/users/{user_id}/complete_onboarding', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_PORT => "8080",
  CURLOPT_URL => "http://localhost:8080/users/{user_id}/complete_onboarding",
  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([
    'address' => [
        'city' => 'Bengaluru',
        'country' => 'IN',
        'line1' => '123, MG Road',
        'pincode' => '560001',
        'state' => 'Karnataka',
        'raw' => '<string>',
        'line2' => 'Flat 4B, Sunrise Apartments'
    ],
    'bank_details' => [
        'account_number' => '50123456789',
        'ifsc_code' => 'HDFC0000001'
    ],
    'dob' => '2000-01-15',
    'first_name' => '<string>',
    'last_name' => '<string>',
    'email' => '<string>'
  ]),
  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 := "http://localhost:8080/users/{user_id}/complete_onboarding"

	payload := strings.NewReader("{\n  \"address\": {\n    \"city\": \"Bengaluru\",\n    \"country\": \"IN\",\n    \"line1\": \"123, MG Road\",\n    \"pincode\": \"560001\",\n    \"state\": \"Karnataka\",\n    \"raw\": \"<string>\",\n    \"line2\": \"Flat 4B, Sunrise Apartments\"\n  },\n  \"bank_details\": {\n    \"account_number\": \"50123456789\",\n    \"ifsc_code\": \"HDFC0000001\"\n  },\n  \"dob\": \"2000-01-15\",\n  \"first_name\": \"<string>\",\n  \"last_name\": \"<string>\",\n  \"email\": \"<string>\"\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("http://localhost:8080/users/{user_id}/complete_onboarding")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"address\": {\n    \"city\": \"Bengaluru\",\n    \"country\": \"IN\",\n    \"line1\": \"123, MG Road\",\n    \"pincode\": \"560001\",\n    \"state\": \"Karnataka\",\n    \"raw\": \"<string>\",\n    \"line2\": \"Flat 4B, Sunrise Apartments\"\n  },\n  \"bank_details\": {\n    \"account_number\": \"50123456789\",\n    \"ifsc_code\": \"HDFC0000001\"\n  },\n  \"dob\": \"2000-01-15\",\n  \"first_name\": \"<string>\",\n  \"last_name\": \"<string>\",\n  \"email\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("http://localhost:8080/users/{user_id}/complete_onboarding")

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

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"address\": {\n    \"city\": \"Bengaluru\",\n    \"country\": \"IN\",\n    \"line1\": \"123, MG Road\",\n    \"pincode\": \"560001\",\n    \"state\": \"Karnataka\",\n    \"raw\": \"<string>\",\n    \"line2\": \"Flat 4B, Sunrise Apartments\"\n  },\n  \"bank_details\": {\n    \"account_number\": \"50123456789\",\n    \"ifsc_code\": \"HDFC0000001\"\n  },\n  \"dob\": \"2000-01-15\",\n  \"first_name\": \"<string>\",\n  \"last_name\": \"<string>\",\n  \"email\": \"<string>\"\n}"

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

{
  "access_token": "<string>",
  "user": {
    "created_at": "2026-01-15T12:34:56",
    "last_modified_at": "2026-01-15T12:34:56",
    "phone_country_code": "<string>",
    "phone_number": "<string>",
    "user_id": "012345678901",
    "address": {
      "city": "Bengaluru",
      "country": "IN",
      "line1": "123, MG Road",
      "pincode": "560001",
      "state": "Karnataka",
      "raw": "<string>",
      "line2": "Flat 4B, Sunrise Apartments"
    },
    "dob": "2000-01-15",
    "email": "<string>",
    "first_name": "<string>",
    "last_name": "<string>"
  }
}

Authorizations

Authorization

string

header

required

JWT bearer token. App-user tokens are issued by POST /auth/token (the partner backend calls it as its platform service account); admin and dashboard tokens are issued via OIDC login.

Path Parameters

user_id

string

required

User ID

Body

application/json

address

required

A user-submitted address as captured: either the structured form, a single free-text string, or both (the original text plus whatever was structured from it). #[serde(untagged)] keeps the wire shape natural — a bare object or a bare string — so existing structured clients are unaffected.

raw is Secret because a free-text address is PII (it embeds the same data masked elsewhere as line1 / pincode).

Show child attributes

bank_details

object

required

Origin-bank details required to open a purpose-bound account at PBA.

Show child attributes

dob

string

required

Example:

"2000-01-15"

first_name

string

required

gender

enum<string>

required

User gender.

Available options:

MALE,

FEMALE,

OTHER

last_name

string

required

salutation

enum<string>

required

Title or honorific for a person.

Available options:

MR,

MRS,

MS,

MASTER

string | null

Response

Onboarding completed

access_token

string

required

user

object

required

Show child attributes

Update User

Add Details (Complete Onboarding)

API Reference

Try It Out

Complete Onboarding

Authorizations

Path Parameters

Body

Response