Skip to main content

onboarding session details

POST 
https://api.sandbox.noah.com/v1/customers/hosted-onboarding

Retrieve details for customer onboarding session

Request​

Header Parameters

    Api-Signature string

    Digitally signed JWT.

Bodyrequired

    CustomerIDCustomerID (string)required

    A unique ID which identifies the customer in the Business' internal system and in NOAH.

    Possible values: non-empty and <= 36 characters

    Example: 550e8400-e29b-41d4-a716-446655440000
    ReturnURLurirequired

    The URL to which the user is redirected at the end of the Hosted Checkout session. We will include the CheckoutSessionID, ExternalID and Status of the session, ie ?CheckoutSessionID={CheckoutSessionID}&ExternalID={ExternalID}&Status={Status}

    Possible values: >= 10 characters and <= 1000 characters

Responses​

HostedURL successfully created.

Schema
    HostedURLurirequired

    URL to redirect the customer to the kyc page.

Authorization: X-Api-Key

name: X-Api-Keytype: apiKeydescription: This security scheme requires an API Key to successfully authenticate.in: header
curl -L 'https://api.sandbox.noah.com/v1/customers/hosted-onboarding' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'X-Api-Key: <X-Api-Key>' \
-d '{
  "CustomerID": "550e8400-e29b-41d4-a716-446655440000",
  "ReturnURL": "string"
}'
Request Collapse all
Base URL
https://api.sandbox.noah.com/v1
Auth
Parameters
— header
Body required
{
  "CustomerID": "550e8400-e29b-41d4-a716-446655440000",
  "ReturnURL": "string"
}
ResponseClear

Click the Send API Request button above and see the response here!