Update hosted step submission

curl --request PATCH \
  --url https://api.blockradar.co/v1/customers/{customerId}/onboarding-requests/{caseId}/hosted-sessions/{sequenceIndex}/submission \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "submitted": true
}
'

import requests

url = "https://api.blockradar.co/v1/customers/{customerId}/onboarding-requests/{caseId}/hosted-sessions/{sequenceIndex}/submission"

payload = { "submitted": True }
headers = {
    "x-api-key": "<api-key>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'PATCH',
  headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({submitted: true})
};

fetch('https://api.blockradar.co/v1/customers/{customerId}/onboarding-requests/{caseId}/hosted-sessions/{sequenceIndex}/submission', 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.blockradar.co/v1/customers/{customerId}/onboarding-requests/{caseId}/hosted-sessions/{sequenceIndex}/submission",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PATCH",
  CURLOPT_POSTFIELDS => json_encode([
    'submitted' => true
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "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"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.blockradar.co/v1/customers/{customerId}/onboarding-requests/{caseId}/hosted-sessions/{sequenceIndex}/submission"

	payload := strings.NewReader("{\n  \"submitted\": true\n}")

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

	req.Header.Add("x-api-key", "<api-key>")
	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.patch("https://api.blockradar.co/v1/customers/{customerId}/onboarding-requests/{caseId}/hosted-sessions/{sequenceIndex}/submission")
  .header("x-api-key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"submitted\": true\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.blockradar.co/v1/customers/{customerId}/onboarding-requests/{caseId}/hosted-sessions/{sequenceIndex}/submission")

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

request = Net::HTTP::Patch.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"submitted\": true\n}"

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

{
  "status": true,
  "message": "<string>",
  "data": {
    "customerId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "case": {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "businessId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "customerId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "providerId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "subjectType": "customer",
      "status": "draft",
      "mode": "api_only",
      "createdAt": "2023-11-07T05:31:56Z",
      "updatedAt": "2023-11-07T05:31:56Z",
      "feature": "<string>",
      "providerReference": "<string>",
      "routeIntent": {},
      "data": {},
      "hostedSessions": [
        {}
      ],
      "reason": "<string>",
      "metadata": {},
      "actions": [
        {}
      ],
      "availableActions": [
        "edit_and_resubmit"
      ]
    }
  }
}

{
  "statusCode": 123,
  "message": "<string>",
  "details": {
    "code": "CUSTOMER_ONBOARDING_REQUIRED",
    "customerId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "provider": {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "slug": "<string>",
      "name": "<string>"
    },
    "onboarding": {
      "caseId": "<string>",
      "status": "<string>",
      "providerStatus": "<string>",
      "action": {
        "type": "create_case",
        "method": "POST",
        "path": "/v1/customers/18d2f159-e0cd-4a45-b735-e9dfe0f7520a/onboarding-requests",
        "body": {
          "provider": "<string>",
          "type": "onramp"
        }
      }
    }
  },
  "requestId": "<string>"
}

{
  "statusCode": 123,
  "message": "<string>",
  "details": {
    "code": "CUSTOMER_ONBOARDING_REQUIRED",
    "customerId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "provider": {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "slug": "<string>",
      "name": "<string>"
    },
    "onboarding": {
      "caseId": "<string>",
      "status": "<string>",
      "providerStatus": "<string>",
      "action": {
        "type": "create_case",
        "method": "POST",
        "path": "/v1/customers/18d2f159-e0cd-4a45-b735-e9dfe0f7520a/onboarding-requests",
        "body": {
          "provider": "<string>",
          "type": "onramp"
        }
      }
    }
  },
  "requestId": "<string>"
}

PATCH

customers

{customerId}

onboarding-requests

{caseId}

hosted-sessions

{sequenceIndex}

submission

Update hosted step submission

curl --request PATCH \
  --url https://api.blockradar.co/v1/customers/{customerId}/onboarding-requests/{caseId}/hosted-sessions/{sequenceIndex}/submission \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "submitted": true
}
'

import requests

url = "https://api.blockradar.co/v1/customers/{customerId}/onboarding-requests/{caseId}/hosted-sessions/{sequenceIndex}/submission"

payload = { "submitted": True }
headers = {
    "x-api-key": "<api-key>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'PATCH',
  headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({submitted: true})
};

fetch('https://api.blockradar.co/v1/customers/{customerId}/onboarding-requests/{caseId}/hosted-sessions/{sequenceIndex}/submission', 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.blockradar.co/v1/customers/{customerId}/onboarding-requests/{caseId}/hosted-sessions/{sequenceIndex}/submission",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PATCH",
  CURLOPT_POSTFIELDS => json_encode([
    'submitted' => true
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "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"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.blockradar.co/v1/customers/{customerId}/onboarding-requests/{caseId}/hosted-sessions/{sequenceIndex}/submission"

	payload := strings.NewReader("{\n  \"submitted\": true\n}")

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

	req.Header.Add("x-api-key", "<api-key>")
	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.patch("https://api.blockradar.co/v1/customers/{customerId}/onboarding-requests/{caseId}/hosted-sessions/{sequenceIndex}/submission")
  .header("x-api-key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"submitted\": true\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.blockradar.co/v1/customers/{customerId}/onboarding-requests/{caseId}/hosted-sessions/{sequenceIndex}/submission")

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

request = Net::HTTP::Patch.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"submitted\": true\n}"

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

{
  "status": true,
  "message": "<string>",
  "data": {
    "customerId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "case": {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "businessId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "customerId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "providerId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "subjectType": "customer",
      "status": "draft",
      "mode": "api_only",
      "createdAt": "2023-11-07T05:31:56Z",
      "updatedAt": "2023-11-07T05:31:56Z",
      "feature": "<string>",
      "providerReference": "<string>",
      "routeIntent": {},
      "data": {},
      "hostedSessions": [
        {}
      ],
      "reason": "<string>",
      "metadata": {},
      "actions": [
        {}
      ],
      "availableActions": [
        "edit_and_resubmit"
      ]
    }
  }
}

{
  "statusCode": 123,
  "message": "<string>",
  "details": {
    "code": "CUSTOMER_ONBOARDING_REQUIRED",
    "customerId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "provider": {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "slug": "<string>",
      "name": "<string>"
    },
    "onboarding": {
      "caseId": "<string>",
      "status": "<string>",
      "providerStatus": "<string>",
      "action": {
        "type": "create_case",
        "method": "POST",
        "path": "/v1/customers/18d2f159-e0cd-4a45-b735-e9dfe0f7520a/onboarding-requests",
        "body": {
          "provider": "<string>",
          "type": "onramp"
        }
      }
    }
  },
  "requestId": "<string>"
}

{
  "statusCode": 123,
  "message": "<string>",
  "details": {
    "code": "CUSTOMER_ONBOARDING_REQUIRED",
    "customerId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "provider": {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "slug": "<string>",
      "name": "<string>"
    },
    "onboarding": {
      "caseId": "<string>",
      "status": "<string>",
      "providerStatus": "<string>",
      "action": {
        "type": "create_case",
        "method": "POST",
        "path": "/v1/customers/18d2f159-e0cd-4a45-b735-e9dfe0f7520a/onboarding-requests",
        "body": {
          "provider": "<string>",
          "type": "onramp"
        }
      }
    }
  },
  "requestId": "<string>"
}

After the customer completes a hosted step, set submitted to true. Use the step’s returned sequenceIndex, rather than its position in the array. This records completion of the step. Provider verification determines whether the customer is approved.

Authorizations

x-api-key

string

header

required

Path Parameters

customerId

string<uuid>

required

Customer identifier.

caseId

string<uuid>

required

Customer onboarding case identifier.

sequenceIndex

integer

required

sequenceIndex returned on the hosted session.

Body

application/json

submitted

boolean

required

Response

Customer onboarding request updated.

status

boolean

required

Example:

true

message

string

required

data

object

required

Show child attributes

API Documentation

Wallet

Addresses

Customer

Asset

Transactions

Withdraw

Withdraw Fiat

Signing

Swap

Liquidity Pool

Virtual Accounts

Deposit Fiat

Auto Settlements

Smart Contract

Gateway

Payment Links

AML

Asset Recovery

Miscellaneous

Rewards

Update hosted step submission

Authorizations

Path Parameters

Body

Response