Noah Business API

https://docs.noah.com
Admin
Noah Business API enables global payment rails in 120+ fiat currencies, Bitcoin, and stablecoins...
Tokens:176,184
Snippets:1,045
Trust Score:8.5
Update:2 weeks ago
Show doc for...
Tokens:
Raw
### POST /onboarding/{CustomerID}

Source: https://docs.noah.com/api-reference//noah-business-api

Creates an onboarding session for a customer.

```APIDOC
## POST /onboarding/{CustomerID}

### Description
Creates an onboarding session for a customer.

### Method
POST

### Endpoint
`/onboarding/{CustomerID}`

### Parameters
#### Path Parameters
- **CustomerID** (string) - Required - The unique identifier of the customer.

### Response
#### Success Response (200)
Returns the onboarding session details.

#### Response Example
```json
{
  "session": {}
}
```
```

--------------------------------

### GET /v1/channels/:ChannelID/form

Source: https://docs.noah.com/api-reference/dynamic-form.md

Documentation for the GET /v1/channels/:ChannelID/form endpoint, including parameters, authentication, and a request example.

```APIDOC
## GET /v1/channels/:ChannelID/form

### Description
Retrieves a dynamic form for a specified channel, optionally filtered by customer, payment method, or self flag. Requires an API key for authentication.

### Method
GET

### Endpoint
`/v1/channels/:ChannelID/form`

### Parameters
#### Path Parameters
- **ChannelID** (string) - Required - The unique identifier of the channel.

#### Query Parameters
- **CustomerID** (string) - Optional - The unique identifier of the customer.
- **PaymentMethodID** (string) - Optional - The unique identifier of the payment method.
- **Self** (boolean) - Optional - Indicates whether to retrieve the form for the current user.

#### Headers
- **X-Api-Key** (string) - Required - Your Noah API key. Required on all requests.
- **Api-Signature** (string) - Optional - Signature for request verification.

### Request Example
```
curl -L 'https://api.sandbox.noah.com/v1/channels/:ChannelID/form?CustomerID=550e8400-e29b-41d4-a716-446655440000' \
  -H 'Accept: application/json' \
  -H 'X-Api-Key: <X-Api-Key>'
```

### Response
#### Success Response (200)
The response contains the dynamic form data. The exact structure is not specified in the source.

#### Response Example
Not provided in the source.
```

--------------------------------

### POST /onboarding-session

Source: https://docs.noah.com/api-reference/create-onboarding-session.md

Creates a hosted onboarding session for a customer. The request body includes customer type, locale, return URL, and optional fiat options and form data. The response provides a hosted URL and optional form schema for verification.

```APIDOC
## POST /onboarding-session

### Description
Creates a hosted onboarding session for a customer. The request body includes customer type, locale, return URL, and optional fiat options and form data. The response provides a hosted URL and optional form schema for verification.

### Method
POST

### Endpoint
/onboarding-session

### Parameters
#### Request Body
- **Metadata** (Record<string, string>) - Optional - Custom user defined key value pairs used for storing additional information.
- **ReturnURL** (string uri) - Required - (length 10-1000)
- **FiatOptions** (object[]) - Optional - Specifies fiat channels the customer will be onboarded to. When omitted, fiat options are resolved from the customer's onboarding record or available channels.
- **FiatOptions[].FiatCurrencyCode** (string) - Required - Supported fiat ISO_4217 3 letter currency codes.
- **Form** (object) - Optional - Form input to be submitted based on returned FormSchema (additional properties allowed)
- **CustomerType** (`Individual` | `Business`) - Optional - Type of customer to onboard. Defaults to Individual if not provided.
- **Locale** (string) - Optional - Checkout / hosted UI language code for URL path segments. Supported values: en, es, fr, de, it, pt. Defaults to en when omitted.

### Request Example
{
  "ReturnURL": "https://example.com/return",
  "CustomerType": "Individual",
  "Locale": "en",
  "FiatOptions": [
    {
      "FiatCurrencyCode": "USD"
    }
  ]
}

### Response
#### Success Response (200)
- **HostedURL** (string uri) - Required - URL to redirect the customer to hosted session.
- **FormSchema** (object) - Optional - [JSONForm](https://jsonforms.io/) schema for the verification fields. If unable to provide, a hosted session is provided via the HostedURL.
- **FormSchema.$schema** (string) - Required - 
- **FormSchema.type** (string) - Required - 
- **FormSchema.title** (string) - Optional - 
- **FormSchema.description** (string) - Optional - 
- **FormSchema.properties** (object) - Required - (additional properties allowed)
- **FormSchema.required** (string[]) - Optional - 
- **FormSchema.allOf** (object[]) - Optional - 
- **OnboardingStatus** (`ReviewNotStarted` | `ReviewPending` | `DocumentInvalid` | `AgreementsRequired` | `Rejected`) - Optional - Indicates the current status of the onboarding process.
- **MissingSteps** (string[]) - Optional - Verification step types that are still incomplete (e.g. IDENTITY, SELFIE, QUESTIONNAIRE). Only present when OnboardingStatus is ReviewNotStarted and the applicant has not yet submitted all required data for the initial verification. For follow-up verification requirements, please refer to customer webhooks.
- **Verifications** (object) - Optional - Current verification state for the customer, including all available required entity verifications. Only shown if a customer was already created via token sharing or previous onboardings.
- **Verifications.Type** (`Individual` | `Business`) - Required - 
- **Verifications.Status** (string) - Required - 
- **Verifications.ActionsRequired** ((`HighRiskInfo` | `HighRiskInfoSenior` | `SourceOfWealth` | `DocumentPageMissing` | `DocumentReupload` | `SelfieReupload` | `ProofOfAddress` | `ProofOfAddressReupload` | `IncorrectTaxID`)[]) - Optional - Additional actions currently required from the customer to complete the review.
- **Verifications.EntityVerifications** (object[]) - Required - 
- **Verifications.EntityVerifications[].Model** (string) - Required - 
- **Verifications.EntityVerifications[].Status** (string) - Required - 
- **Verifications.EntityVerifications[].Created** (string date-time) - Required - 
- **Verifications.EntityVerifications[].Modified** (string date-time) - Required - 
- **Verifications.EntityVerifications[].Entity** (string) - Required - 
- **Verifications.EntityVerifications[].RejectionData** (object) - Optional - 
- **Verifications.EntityVerifications[].RejectionData.RejectType** (`Final` | `Retry`) - Required - 
- **Verifications.EntityVerifications[].RejectionData.PublicComment** (string) - Optional - 

#### Response Example
{
  "HostedURL": "https://hosted.noah.com/session/123",
  "FormSchema": {
    "$schema": "https://json-schema.org/draft/2020-12/schema",
    "type": "object",
    "properties": {}
  },
  "OnboardingStatus": "ReviewNotStarted",
  "MissingSteps": ["IDENTITY", "SELFIE"]
}

#### Error Responses
- **201** - Customer created
- **202** - Onboarding in progress. The review will be processed asynchronously and a webhook will be sent when the review is complete or has advanced to the next step.
- **400** - Bad request
- **401** - Client is not authorized to perform this action
- **500** - Internal server error

Error responses share one `Error` envelope across the whole API. See https://docs.noah.com/api-concepts/errors.md for its fields, the `Type` values, and the field-level validation details in `RequestExtension` and `DenyExtension`.
```

--------------------------------

### GET /v1/channels/:ChannelID

Source: https://docs.noah.com/api-reference/get-channel-by-id.md

Documentation for the GET /v1/channels/:ChannelID endpoint, including parameters, request example, and error response structure.

```APIDOC
## [GET] /v1/channels/:ChannelID

### Description
Retrieves a channel by its ID. The endpoint requires the ChannelID path parameter and the CryptoCurrency query parameter. Optional parameters include FiatAmount, CustomerID, and the Api-Signature header.

### Method
GET

### Endpoint
https://api.sandbox.noah.com/v1/channels/:ChannelID

### Parameters
#### Path Parameters
- **ChannelID** (string) - Required - The unique identifier of the channel.

#### Query Parameters
- **CryptoCurrency** (string) - Required - The cryptocurrency to use for the channel.
- **FiatAmount** (number) - Optional - The fiat amount associated with the channel.
- **CustomerID** (string) - Optional - The customer identifier associated with the channel.

#### Header Parameters
- **X-Api-Key** (string) - Required - Your Noah API key. Required on all requests.
- **Api-Signature** (string) - Optional - Signature for request authentication.

### Request Example
```
curl -L 'https://api.sandbox.noah.com/v1/channels/:ChannelID?CryptoCurrency=BTC&FiatAmount=10.1&CustomerID=550e8400-e29b-41d4-a716-446655440000' \
  -H 'Accept: application/json' \
  -H 'X-Api-Key: <X-Api-Key>'
```

### Response
#### Success Response (200)
The response body is not explicitly defined in the source. The response may include channel details.

#### Error Response
If the request is invalid, the response may include an InvalidMessage object with fields such as Type, Instance, Action, Detail, Extensions, RequestExtension, and DenyExtension.
```

--------------------------------

### Get Customer by ID - curl

Source: https://docs.noah.com/api-reference/customer-by-id.md

Example curl request to retrieve a customer by ID. Requires the X-Api-Key header for authentication.

```bash
curl -L 'https://api.sandbox.noah.com/v1/customers/550e8400-e29b-41d4-a716-446655440000' \
-H 'Accept: application/json' \
-H 'X-Api-Key: <X-Api-Key>'
```

--------------------------------

### POST /onboarding/{CustomerID}

Source: https://docs.noah.com/api-reference/create-onboarding-session.md

Initiates Noah's Standard Model onboarding flow, establishing direct contractual relationships with end customers and handling KYB/KYC verification and Terms and Conditions acceptance.

```APIDOC
## POST /onboarding/{CustomerID}

### Description
Initiates Noah's Standard Model onboarding flow. Through this solution, Noah establishes direct contractual relationships with your end customers, handling all KYB/KYC verification and Terms and Conditions acceptance on your behalf.

### Method
POST

### Endpoint
`https://api.sandbox.noah.com/v1/onboarding/{CustomerID}` (Sandbox)  
`https://api.noah.com/v1/onboarding/{CustomerID}` (Production)

### Parameters
#### Path Parameters
- **CustomerID** (string) - Required - A unique ID which identifies the customer in the Business' internal system and in NOAH. (length 1-42)

### Authentication
- **X-Api-Key** (string) - Required - Your Noah API key. Required on all requests.
- **Api-Signature** (string) - Optional in sandbox when your API key has no associated signing public key; required in production for all requests. If sent, the signature is always validated. Digitally signed JWT used to verify request authenticity.
```

--------------------------------

### Curl Request to Retrieve Dynamic Form

Source: https://docs.noah.com/api-reference/dynamic-form.md

Example curl command to GET a dynamic form from the sandbox API, using the X-Api-Key header and a CustomerID query parameter.

```bash
curl -L 'https://api.sandbox.noah.com/v1/channels/:ChannelID/form?CustomerID=550e8400-e29b-41d4-a716-446655440000' \
-H 'Accept: application/json' \
-H 'X-Api-Key: <X-Api-Key>'
```

--------------------------------

### POST /help/{CustomerID}

Source: https://docs.noah.com/api-reference/help-desk-session.md

Creates a help desk session for a customer. The request must include a return URL where the customer will be redirected after the session.

```APIDOC
## [POST] /help/{CustomerID}

### Description
Creates a help desk session for a customer. The request must include a return URL where the customer will be redirected after the session.

### Method
POST

### Endpoint
https://api.sandbox.noah.com/v1/help/{CustomerID}

### Parameters
#### Path Parameters
- **CustomerID** (string) - Required - The unique identifier of the customer.

#### Header Parameters
- **X-Api-Key** (string) - Required - Your Noah API key. Required on all requests.
- **Api-Signature** (string) - Optional - Signature for request validation.

#### Request Body
- **ReturnURL** (string) - Required - The URL to return to after the help desk session.

### Request Example
```json
{
  "ReturnURL": "string"
}
```

### Response
#### Success Response (200)
- **Type** (ErrorType) - Type of error: InvalidMessage, Unexpected, ResourceNotFound, Unauthorized, Forbidden, InsufficientBalance, Duplicate.
- **Instance** (string) - A unique reference that identifies the specific occurrence of the problem.
- **Action** (string) - Action taking place which resulted in error.
- **Detail** (string) - Details about the error.
- **Extensions** (object) - Additional information about the error.
  - **Request** (object) - Details about invalid request properties.
  - **Features** (object) - Details about the disabled feature flags.
    - **property name*** (string[]) - List of reasons: BetaAccess, GloballyDisabled, Maintenance, RestrictedRegion, Kyc, Suspended.
- **RequestExtension** (object) - Additional information about the request fields.
  - **Body** (object[]) - Array of field errors.
    - **Field** (string) - The full path of the field with error.
    - **Reason** (string) - Reason for the field error: IntegrityValidation, SchemaValidation, NotSupported, SelfReference.
    - **Description** (string) - A more detailed description of the problem or the fix.
- **DenyExtension** (object[]) - Array of access denial details.
  - **Reason** (string) - Reason for access denial: AccountStatus, Compliance, InsufficientPermissions, VerificationRequired.
  - **Description** (string) - A more detailed description of the problem or the fix.
  - **Principal** (object) - The principal that was denied access.
    - **ID** (string) - ID of the principal.
    - **Type** (string) - Type of principal: User, Customer.
    - **Subtype** (string) - Subtype of principal: Individual, Business.
  - **Resource** (object) - The resource that access was denied to.
    - **ID** (string) - ID of the resource.
    - **Type** (DenyExtensionResourceType) - Type of resource that access was denied to.

#### Response Example
```json
{
  "Type": "InvalidMessage",
  "Instance": "string",
  "Action": "string",
  "Detail": "string",
  "Extensions": {
    "Request": {},
    "Features": {}
  },
  "RequestExtension": {
    "Body": [
      {
        "Field": "string",
        "Reason": "string",
        "Description": "string"
      }
    ]
  },
  "DenyExtension": [
    {
      "Reason": "string",
      "Description": "string",
      "Principal": {
        "ID": "string",
        "Type": "string",
        "Subtype": "string"
      },
      "Resource": {
        "ID": "string",
        "Type": "string"
      }
    }
  ]
}
```
```

--------------------------------

### Example JWT Payload with Params

Source: https://docs.noah.com/api-concepts/authentication/signing.md

Shows the JWT payload structure for a GET request with query parameters. The 'queryParams' claim is required when the request uses query parameters.

```json
{
  "aud": "https://api.noah.com",
  "iat": 1719820231,
  "exp": 1719820831,
  "method": "GET",
  "path": "/v1/transactions",
  "queryParams": {
    "PageSize": 20,
    "SortDirection": "ASC"
  }
}
```

--------------------------------

### Create Onboarding Session - HTTP Request

Source: https://docs.noah.com/api-reference/create-onboarding-session.md

Initiates Noah's Standard Model onboarding flow. The CustomerID path parameter is required and must be a unique ID (1-42 characters) identifying the customer in your system and in Noah.

```http
POST /onboarding/{CustomerID}
```

--------------------------------

### Get Document Upload URL with curl

Source: https://docs.noah.com/api-reference/get-document-upload-url.md

Example curl command to request a document upload URL. Requires the X-Api-Key header and a valid CustomerID and CountryCode query parameter.

```curl
curl -L 'https://api.sandbox.noah.com/v1/onboarding/550e8400-e29b-41d4-a716-446655440000/prefill/documents/upload-url?CountryCode=US' \
-H 'Accept: application/json' \
-H 'X-Api-Key: <X-Api-Key>'
```

--------------------------------

### Customer create/update request body example

Source: https://docs.noah.com/api-reference/create-update-customer.md

Example JSON body for creating or updating a customer. Shows the required fields: Type, FullName, DateOfBirth, Email, PhoneNumber, Identities (with IssuingCountry, IDNumber, IssuedDate, ExpiryDate, IDType), and PrimaryResidence (with Street, Street2, City, PostCode, State, Country). Dates must match the format YYYY-MM-DD and IDType must be one of the enumerated values such as Passport.

```json
{  

  "Type": "Individual",  

  "FullName": {  

    "FirstName": "string",  

    "LastName": "string",  

    "MiddleName": "string"  

  },  

  "DateOfBirth": "2024-04-16",  

  "Email": "user@example.com",  

  "PhoneNumber": "string",  

  "Identities": [  

    {  

      "IssuingCountry": "US",  

      "IDNumber": "string",  

      "IssuedDate": "2024-04-16",  

      "ExpiryDate": "2024-04-16",  

      "IDType": "Passport"  

    }  

  ],  

  "PrimaryResidence": {  

    "Street": "string",  

    "Street2": "string",  

    "City": "string",  

    "PostCode": "string",  

    "State": "string",  

    "Country": "US"  

  }  

}  
```

--------------------------------

### Channel Response Payload

Source: https://docs.noah.com/api-concepts/channels.md

Example response body for each channel returned by the GET /channels/sell call. Includes calculated total fee, country, fiat currency, form schema for the payment method, channel ID, limits, payment method details, processing time, and rate.

```typescript
{
  "Calculated": {
    "TotalFee": "2"
  },
  "Country": "DE",
  "FiatCurrency": "EUR",
  "FormSchema": {
    "$schema": "http://json-schema.org/draft-07/schema#",
    "type": "object",
    "properties": {
      "BankDetails": {
        "properties": {
          "AccountType": {
            "enum": [
              "Checking",
              "Savings"
            ],
            "title": "Account Type",
            "type": "string"
          },
          "AccountNumber": {
            "maxLength": 22,
            "minLength": 22,
            "pattern": "^DE[0-9]{2}[A-Z0-9]{18}$",
            "title": "IBAN",
            "type": "string"
          }
        },
        "required": [
          "AccountType",
          "AccountNumber"
        ],
        "title": "Bank Details",
        "type": "object"
      }
    },
    "required": [
      "BankDetails"
    ]
  },
  "ID": "ebb9736b-08b3-599d-886b-10ee8aea82b5",
  "Limits": {
    "MinLimit": "1"
  },
  "PaymentMethodCategory": "Bank",
  "PaymentMethodType": "BankSepa",
  "ProcessingSeconds": 60,
  "Rate": "0.86"
}
```

--------------------------------

### List Payment Methods with curl

Source: https://docs.noah.com/api-reference/payment-methods.md

Example curl command to list payment methods. Requires a valid CustomerID and X-Api-Key header. Uses the sandbox base URL.

```curl
curl -L 'https://api.sandbox.noah.com/v1/payment-methods?CustomerID=550e8400-e29b-41d4-a716-446655440000&PageSize=20' \
-H 'Accept: application/json' \
-H 'X-Api-Key: <X-Api-Key>'
```

--------------------------------

### POST /onboarding/{CustomerID}/prefill

Source: https://docs.noah.com/api-reference//noah-business-api

Prefills customer details for an onboarding session.

```APIDOC
## POST /onboarding/{CustomerID}/prefill

### Description
Prefills customer details for an onboarding session.

### Method
POST

### Endpoint
`/onboarding/{CustomerID}/prefill`

### Parameters
#### Path Parameters
- **CustomerID** (string) - Required - The unique identifier of the customer.

### Response
#### Success Response (200)
Returns the prefill result.

#### Response Example
```json
{
  "prefill": {}
}
```
```

--------------------------------

### Get Transaction Details with GET /transactions/:TransactionID

Source: https://docs.noah.com/api-concepts/transactions.md

Retrieves details of a specific transaction using the GET /transactions/:TransactionID endpoint. Requires the TransactionID from /transactions/sell, /transactions/withdraw, Transactions events, or the Business Dashboard.

```typescript
curl -L 'https://api.sandbox.noah.com/v1/transactions/:TransactionID' \
-H 'Accept: application/json' \
-H 'X-Api-Key: <X-Api-Key>'
```

--------------------------------

### get

Source: https://docs.noah.com/api-concepts/authentication/signing.md

Makes a GET request to the specified API endpoint with a signed JWT in the Api-Signature header.

```APIDOC
## get

### Description
Makes a GET request to the specified API endpoint with a signed JWT in the Api-Signature header.

### Method
get

### Signature
```ts
export async function get(opts: {
  path: string;
  privateKey: string;
  queryParams?: Record<string, string | number>;
}): Promise<AxiosResponse>
```

### Parameters
- **path** (string) - Required - The path of the request, e.g., /api/v1/customers.
- **privateKey** (string) - Required - The private key used to sign the JWT, in PEM format.
- **queryParams** (Record<string, string | number>) - Optional - The query parameters of the request.

### Returns
A promise that resolves to the Axios response.

### Throws
Will throw an error if the request fails.

### Example
```ts
const response = await get({
  path: '/api/v1/customers',
  privateKey: '...',
  queryParams: { limit: 10 },
});
```
```
Tokens:
Raw