Skip to main content
POST
/
clients
/
me
/
integrations
/
noah
/
customers
/
kyc
Initiate KYC onboarding
curl --request POST \
  --url https://api.portalhq.io/api/v3/clients/me/integrations/noah/customers/kyc \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "returnUrl": "<string>",
  "fiatOptions": [
    {
      "fiatCurrencyCode": "<string>"
    }
  ],
  "metadata": {},
  "form": {}
}
'
{
  "data": {
    "hostedUrl": "<string>"
  }
}

Authorizations

​
Authorization
string
header
required

Client API Key or Client Session Token (CST). Pass as a Bearer token in the Authorization header.

Body

application/json
​
returnUrl
string<uri>
required

HTTPS return URL used after hosted onboarding.

Pattern: ^https://
​
fiatOptions
object[]

Optional list of fiat options for onboarding.

​
customerType
enum<string>
Available options:
Individual,
Business
​
metadata
object
​
form
object

Response

KYC onboarding session retrieved successfully

​
data
object