CryptoRails

https://docs.swipelux.com/
Admin
CryptoRails is a custodial wallet management platform providing simplified blockchain infrastructure...
Tokens:69,797
Snippets:437
Trust Score:7.5
Update:7 months ago
Show doc for...
Tokens:
Raw
### Fiat to Crypto Transfer Example (JSON)

Source: https://docs.swipelux.com/rails

This JSON object illustrates a fiat-to-crypto payment. It details the source rail (e.g., card) with currency and amount, and the destination rail (e.g., polygon) with its corresponding cryptocurrency and amount.

```json
{
  "from": {
    "rail": "card",
    "id": "cus_123",
    "amount": "100",
    "currency": "USD"
  },
  "to": {
    "rail": "polygon",
    "id": "cus_123",
    "amount": "100",
    "currency": "USDC"
  }
}
```

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

### Setup Webhook Configuration

Source: https://docs.swipelux.com/api-reference/webhooks/set

Configure or update your webhook endpoint to receive real-time notifications about events in your merchant account.

```APIDOC
## POST /websites/swipelux/webhooks

### Description
Configure or update your webhook endpoint to receive real-time notifications about events in your merchant account.

### Method
POST

### Endpoint
/websites/swipelux/webhooks

### Parameters
#### Request Body
- **url** (string) - Required - HTTPS URL where webhooks will be sent
- **events** (array) - Required - Array of event types to subscribe to. Supported events include:
  - `customer.created`: New individual customer created
  - `customer.updated`: Customer data updated
  - `customer.verification_changed`: KYC/KYB status changed
  - `business.created`: New business customer created
  - `business.updated`: Business customer data updated
  - `wallet.created`: Custodial wallet created
  - `wallet.imported`: External wallet imported
  - `document.uploaded`: Document uploaded for customer/shareholder
  - `account.created`: Virtual bank account created
  - `account.imported`: External bank account imported
  - `account.deleted`: Bank account deleted
  - `transfer.created`: Transfer initiated
  - `transfer.updated`: Transfer status changed
  - `transfer.completed`: Transfer completed
  - `transfer.failed`: Transfer failed
  - `transfer.funded_partial`: Partial funding received
  - `transfer.amount_adjusted`: Transfer amount adjusted

### Request Example
```json
{
  "url": "https://your-webhook-url.com/callback",
  "events": [
    "customer.created",
    "transfer.completed"
  ]
}
```

### Response
#### Success Response (200)
- **message** (string) - Confirmation message indicating the webhook configuration was updated.

#### Response Example
```json
{
  "message": "Webhook configuration updated successfully."
}
```
```

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

### Crypto Transfer Example (JSON)

Source: https://docs.swipelux.com/rails

This JSON object demonstrates a typical crypto transfer between two accounts on the same blockchain network. It specifies the source and destination rails, customer IDs, and amounts.

```json
{
  "from": {
    "rail": "polygon",
    "id": "cus_123",
    "amount": "25"
  },
  "to": {
    "rail": "polygon",
    "id": "0x1234567890abcdef1234567890abcdef12345678",
    "amount": "25"
  }
}
```

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

### GET /v1/customers/business/{id}

Source: https://docs.swipelux.com/business-onboarding/workflow

Retrieves the current verification status of a business customer.

```APIDOC
## GET /v1/customers/business/{id}

### Description
Retrieves the full profile and current verification status of a business customer.

### Method
GET

### Endpoint
/v1/customers/business/{id}

### Parameters
#### Path Parameters
- **id** (string) - Required - The unique business customer ID

### Response
#### Success Response (200)
- **verificationStatus** (string) - Current status (e.g., pending, approved, rejected)

#### Response Example
{
  "id": "cust_abc123",
  "verificationStatus": "approved"
}
```

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

### GET /v1/customers/{id}

Source: https://docs.swipelux.com/individual-onboarding

Retrieves the current status and details of a customer, including their KYC verification status.

```APIDOC
## GET /v1/customers/{id}

### Description
Fetches the full profile and current KYC status of a customer.

### Method
GET

### Endpoint
/v1/customers/{id}

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

### Response
#### Success Response (200)
- **id** (string) - Customer ID
- **status** (string) - Current verification status

#### Response Example
{
  "id": "cust_123456789",
  "status": "verified"
}
```

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

### Initialize Node.js Webhook Project

Source: https://docs.swipelux.com/webhooks/handle-deliveries

Steps to create a new project directory, initialize the package manifest, and install the necessary Express and body-parser dependencies.

```bash
mkdir webhook-handler
cd webhook-handler
npm init -y
npm install express body-parser
```

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

### Install Swipelux OnRamp SDK

Source: https://docs.swipelux.com/rails/card-integration/client-side/react

The command to install the necessary npm package for integrating the Swipelux OnRamp widget into a React project.

```bash
npm install @swipelux/onramp-react
```

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

### GET /v1/meta/kyb/documents

Source: https://docs.swipelux.com/business-onboarding/workflow

Retrieves the list of required documents based on the business jurisdiction.

```APIDOC
## GET /v1/meta/kyb/documents

### Description
Fetches a list of mandatory documents required for KYB verification based on the business jurisdiction.

### Method
GET

### Endpoint
/v1/meta/kyb/documents

### Response
#### Success Response (200)
- **documents** (array) - List of required document types

#### Response Example
{
  "documents": ["certificate_of_incorporation", "articles_of_association", "proof_of_address"]
}
```

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

### Basic Swipelux Widget Setup

Source: https://docs.swipelux.com/rails/card-integration/client-side/widget-customization

Demonstrates the fundamental steps to initialize and mount the Swipelux widget in a web application. It requires a publishable API key and a target DOM element for mounting.

```javascript
const widget = new SwipeluxWidget({
  apiKey: "YOUR_PUBLISHABLE_API_KEY",
  // Add customization options here
});

widget.mount(document.getElementById("swipelux-container"));
```

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

### GET /v1/customers/{customerId}/balances

Source: https://docs.swipelux.com/core-flow/wallets/get-balance

Retrieve real-time balance information for all blockchain networks associated with a specific customer.

```APIDOC
## GET /v1/customers/{customerId}/balances

### Description
Retrieves the balance information for all wallets associated with the specified customer. Returns balances across all blockchain networks in real-time.

### Method
GET

### Endpoint
/v1/customers/{customerId}/balances

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

### Request Example
GET /v1/customers/cus_abc123/balances

### Response
#### Success Response (200)
- **balances** (array) - A list of wallet balances across different blockchain networks.

#### Response Example
{
  "customerId": "cus_abc123",
  "balances": [
    {
      "network": "ethereum",
      "balance": "0.5",
      "currency": "ETH"
    }
  ]
}
```

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

### GET /customers

Source: https://docs.swipelux.com/api-reference/customers/get-all

Retrieve a paginated list of all customers associated with your merchant account.

```APIDOC
## GET /customers

### Description
Retrieve a paginated list of all customers associated with your merchant account.

### Method
GET

### Endpoint
/customers

### Parameters
#### Query Parameters
- **limit** (number) - Optional - Number of customers to retrieve (max: 100). Default: 20.
- **offset** (number) - Optional - Number of customers to skip for pagination. Default: 0.

### Request Example
GET /customers?limit=10&offset=0

### Response
#### Success Response (200)
- **customers** (array) - List of customer objects.

#### Response Example
{
  "customers": [
    {
      "id": "cust_123",
      "name": "John Doe",
      "email": "john@example.com"
    }
  ]
}
```

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

### Create Business Customer Python Request

Source: https://docs.swipelux.com/core-flow/customers/business

This snippet shows how to create a business customer using Python's 'requests' library. It sends a POST request to the Swipelux API with the necessary JSON payload. Ensure you have the 'requests' library installed (`pip install requests`).

```python
import requests
import json

api_url = 'https://api.swipelux.com/v1/customers/business'
api_key = 'YOUR_API_KEY'  # Replace with your actual API key

customer_data = {
  "firstName": "John",
  "lastName": "Smith",
  "birthDate": "1975-03-15",
  "email": "emma5698@mail.com",
  "phone": "+19407151494",
  "jurisdiction": "US",
  "entityType": "LLC",
  "entityName": "Acme Corporation LLC",
  "tradeName": "Acme Tech Solutions",
  "registrationNumber": "LLC-2015-123456",
  "taxNumber": "98-7654321",
  "businessDescription": "We provide software development and consulting services for enterprise clients worldwide",
  "businessType": "Technology",
  "websites": [
    "https://acmecorp.com",
    "https://acmetech.io"
  ],
  "phoneNumber": "+14419205543",
  "addressCountry": "US",
  "streetAddress": "123 Market Street",
  "addressLine2": "Suite 500",
  "city": "San Francisco",
  "state": "CA",
  "zip": "94105",
  "sourceOfFunds": "Business Revenue",
  "expectedMonthlyVolumeUsd": 50000,
  "purposeOfFunds": "Business Operations",
  "flowOfFundsDescription": "Client payments received via bank transfer, used for operational expenses and vendor payments",
  "sanctionedCountryOperations": false,
  "highRiskActivities": [],
  "documents": [
    {
      "purposes": [
        "certificate_of_incorporation"
      ],
      "file": "data:application/pdf;base64,JVBERi0xLjQKJeLjz9MKMyAwIG9iago8PC9UeXBlL..."
    },
    {
      "purposes": [
        "power_of_attorney"
      ],
      "file": "data:application/pdf;base64,JVBERi0xLjQKJeLjz9MKMyAwIG9iago8PC9UeXBlL..."
    },
    {
      "purposes": [
        "corporate_structure"
      ],
      "file": "data:application/pdf;base64,JVBERi0xLjQKJeLjz9MKMyAwIG9iago8PC9UeXBlL..."
    },
    {
      "purposes": [
        "director_structure"
      ],
      "file": "data:application/pdf;base64,JVBERi0xLjQKJeLjz9MKMyAwIG9iago8PC9UeXBlL..."
    },
    {
      "purposes": [
        "proof_of_address"
      ],
      "file": "data:image/jpeg;base64,/9j/4AAQSkZJRgABAQEAYABgAAD/2wBDAAgGBgcGBQgHBwcJCQgKDBQNDAsLDBkSEw8U..."
    }
  ],
  "shareholders": [
    {
      "firstName": "Jane",
      "lastName": "Doe",
      "birthDate": "1980-05-20",
      "email": "jane@acmecorp.com",
      "phone": "+18437986129",
      "title": "CEO",
      "ownershipPercentage": 100,
      "hasControl": true,
      "isSigner": true,
      "isDirector": true,
      "address": {
        "streetAddress": "456 Oak Avenue",
        "city": "San Francisco",
        "country": "US",
        "zip": "94102"
      },
      "identifyingInformation": [
        {
          "type": "passport",
          "issuingCountry": "US",
          "number": "123456789"
        }
      ],
      "documents": [
        {
          "purposes": [
            "drivers_license_front"
          ],
          "file": "data:image/jpeg;base64,/9j/4AAQSkZJRgABAQEAYABgAAD/2wBDAAgGBgcGBQgHBwcJCQgKDBQNDAsLDBkSEw8U..."
        },
        {
          "purposes": [
            "drivers_license_back"
          ],
          "file": "data:image/jpeg;base64,/9j/4AAQSkZJRgABAQEAYABgAAD/2wBDAAgGBgcGBQgHBwcJCQgKDBQNDAsLDBkSEw8U..."
        },
        {
          "purposes": [
            "proof_of_address"
          ],
          "file": "data:image/jpeg;base64,/9j/4AAQSkZJRgABAQEAYABgAAD/2wBDAAgGBgcGBQgHBwcJCQgKDBQNDAsLDBkSEw8U..."
        }
      ]
    }
  ]
}

headers = {
    'Authorization': f'Bearer {api_key}',
    'Content-Type': 'application/json'
}

response = requests.post(api_url, headers=headers, data=json.dumps(customer_data))

if response.status_code == 200:
    print('Success:', response.json())
else:
    print('Error:', response.status_code, response.text)
```

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

### Complete Business Onboarding JSON Payload

Source: https://docs.swipelux.com/core-flow/customers/business

A comprehensive example of the JSON structure required for business onboarding. It includes entity details, financial background, and nested arrays for documents and shareholders.

```json
{
  "firstName": "John",
  "lastName": "Smith",
  "birthDate": "1975-03-15",
  "email": "john@acmecorp.com",
  "phone": "+14155556789",
  "jurisdiction": "US",
  "entityType": "LLC",
  "entityName": "Acme Corporation LLC",
  "tradeName": "Acme Tech Solutions",
  "registrationNumber": "LLC-2015-123456",
  "taxNumber": "98-7654321",
  "businessDescription": "We provide software development and consulting services for enterprise clients worldwide",
  "businessType": "Technology",
  "websites": ["https://acmecorp.com", "https://acmetech.io"],
  "phoneNumber": "+14155550100",
  "addressCountry": "US",
  "streetAddress": "123 Market Street",
  "addressLine2": "Suite 500",
  "city": "San Francisco",
  "state": "CA",
  "zip": "94105",
  "sourceOfFunds": "Business Revenue",
  "expectedMonthlyVolumeUsd": 50000,
  "purposeOfFunds": "Business Operations",
  "flowOfFundsDescription": "Client payments received via bank transfer, used for operational expenses and vendor payments",
  "sanctionedCountryOperations": false,
  "highRiskActivities": [],
  "documents": [
    {
      "purposes": ["certificate_of_incorporation"],
      "file": "data:application/pdf;base64,JVBERi0xLjQKJeLjz9MKMyAwIG9iago8PC9UeXBlL..."
    }
  ],
  "shareholders": []
}
```

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

### Create Individual Customer (JavaScript)

Source: https://docs.swipelux.com/core-flow/customers/individual

Example of creating an individual customer using JavaScript with the Fetch API. This shows how to construct the request body and send a POST request to the Swipelux API.

```javascript
const customerData = {
  "type": "individual",
  "email": "alex6335@test.com",
  "firstName": "John",
  "lastName": "Doe"
};

fetch('https://api.swipelux.com/v1/customers', {
  method: 'POST',
  headers: {
    'Content-Type': 'application/json'
  },
  body: JSON.stringify(customerData)
})
.then(response => response.json())
.then(data => console.log(data))
.catch(error => console.error('Error:', error));
```

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

### Create Individual Customer (Python)

Source: https://docs.swipelux.com/core-flow/customers/individual

Example of creating an individual customer using Python with the 'requests' library. This illustrates how to send JSON data in a POST request to the Swipelux API.

```python
import requests
import json

url = "https://api.swipelux.com/v1/customers"
headers = {
    "Content-Type": "application/json"
}
data = {
  "type": "individual",
  "email": "alex6335@test.com",
  "firstName": "John",
  "lastName": "Doe"
}

response = requests.post(url, headers=headers, data=json.dumps(data))
print(response.json())
```

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

### Standard KYC Workflow Process

Source: https://docs.swipelux.com/individual-onboarding/status-workflow

A sequential representation of the standard KYC onboarding process, starting from customer creation to final approval or rejection.

```text
1. Create Customer (POST /v1/customers)
   └── Status: not_started

2. Initiate KYC (POST /v1/customers/{id}/kyc)
   └── Status: pending_verification
   └── Returns: verificationUrl

3. Customer Completes Verification
   └── Visits verificationUrl
   └── Uploads ID document
   └── Completes selfie/liveness check

4. Automatic Review
   └── Status: under_review

5. Approval/Rejection
   └── Status: approved OR rejected
```

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

### GET /customers/{id}

Source: https://docs.swipelux.com/core-flow/customers/business

Retrieves the full profile of a business customer, including business registration details, shareholder information, and status of submitted documents.

```APIDOC
## GET /customers/{id}

### Description
Retrieves a detailed customer object containing all business information, shareholder details, and document verification status.

### Method
GET

### Endpoint
/customers/{id}

### Parameters
#### Path Parameters
- **id** (string) - Required - The unique customer identifier (starts with 'cus_').

### Response
#### Success Response (200)
- **id** (string) - Unique customer identifier.
- **firstName** (string) - Contact person first name.
- **lastName** (string) - Contact person last name.
- **entityName** (string) - Legal name of the business.
- **documents** (array) - List of business-related documents.
- **shareholders** (array) - List of associated shareholders.

#### Response Example
{
  "id": "cus_TkqrD3axUgHQhHYRLE",
  "firstName": "John",
  "lastName": "Smith",
  "entityName": "Acme Corporation LLC",
  "documents": [],
  "shareholders": []
}
```

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

### Create Individual Customer (cURL)

Source: https://docs.swipelux.com/core-flow/customers/individual

Example of creating an individual customer using cURL. This demonstrates the basic structure of the request body, including optional fields like email, firstName, and lastName.

```shell
curl -X POST https://api.swipelux.com/v1/customers \
-H "Content-Type: application/json" \
-d '{ 
  "type": "individual",
  "email": "alex6335@test.com",
  "firstName": "John",
  "lastName": "Doe"
}'
```

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

### POST /v1/customers/business

Source: https://docs.swipelux.com/business-onboarding

Initiates the business onboarding process by creating a new business customer profile. Requires minimum fields for initial creation.

```APIDOC
## POST /v1/customers/business

### Description
Initiates the business onboarding process by creating a new business customer profile. Requires minimum fields for initial creation.

### Method
POST

### Endpoint
/v1/customers/business

### Parameters
#### Query Parameters
None

#### Request Body
- **firstName** (string) - Required - First name of the primary contact
- **lastName** (string) - Required - Last name of the primary contact
- **email** (string) - Required - Email address of the primary contact
- **entityName** (string) - Required - Legal entity name
- **jurisdiction** (string) - Required - Country of jurisdiction (ISO 3166-1 alpha-2)
- **middleName** (string) - Optional - Middle name of the primary contact
- **birthDate** (date) - Optional - Birth date of primary contact (YYYY-MM-DD)
- **phone** (string) - Optional - Primary contact phone
- **entityType** (enum) - Optional - Business entity type (see Entity Types)
- **entityTypeDescription** (string) - Optional - Custom description when entityType is 'other'
- **tradeName** (string) - Optional - DBA or trading name (if different from legal name)
- **registrationNumber** (string) - Optional - Company registration/incorporation number
- **incorporationDate** (date) - Optional - Date of company incorporation (YYYY-MM-DD)
- **taxNumber** (string) - Optional - Tax identification number (EIN/TIN or local equivalent)
- **businessDescription** (string) - Optional - Description of business activities (min 10 chars)
- **businessType** (enum) - Optional - Industry type (see Business Types)
- **businessTypeDescription** (string) - Optional - Custom description when businessType is 'other'
- **websites** (array) - Optional - Company website URLs (array of strings)
- **phoneNumber** (string) - Optional - Business phone number
- **streetAddress** (string) - Optional - Street address line 1
- **addressLine2** (string) - Optional - Street address line 2
- **city** (string) - Optional - City
- **state** (string) - Optional - State/Province/Region
- **zip** (string) - Optional - Postal/ZIP code
- **addressCountry** (string) - Optional - Country (ISO 3166-1 alpha-2)
- **sourceOfFunds** (enum) - Optional - Primary source of funds
- **sourceOfFundDescription** (string) - Optional - Custom description for source of funds
- **expectedMonthlyVolumeUsd** (number) - Optional - Expected monthly transaction volume in USD
- **purposeOfFunds** (enum) - Optional - Intended use of funds
- **purposeOfFundsDescription** (string) - Optional - Custom description for purpose
- **flowOfFundsDescription** (string) - Optional - Description of how funds will flow (min 10 chars)
- **sanctionedCountryOperations** (boolean) - Optional - Operations in sanctioned countries
- **highRiskActivities** (array) - Optional - List of high-risk activities (array of strings)
- **operatingCountries** (array) - Optional - Array of countries where business operates (ISO 3166-1 alpha-2)
- **handlesCustomerFunds** (boolean) - Optional - Does business handle/move customer funds
- **complianceScreeningDescription** (string) - Optional - Description of compliance screening procedures
- **estimatedAnnualRevenue** (number) - Optional - Estimated annual revenue in USD

### Request Example
```json
{
  "firstName": "John",
  "lastName": "Doe",
  "email": "john.doe@example.com",
  "entityName": "Example Corp",
  "jurisdiction": "US"
}
```

### Response
#### Success Response (200)
- **id** (string) - Unique identifier for the business customer
- **status** (string) - Verification status of the business

#### Response Example
```json
{
  "id": "cus_123abc",
  "status": "pending"
}
```

```

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

### POST /v1/customers/business

Source: https://docs.swipelux.com/business-onboarding/workflow

Initializes the KYB process by creating a new business customer record.

```APIDOC
## POST /v1/customers/business

### Description
Creates a new business customer record to initiate the automated KYB verification process.

### Method
POST

### Endpoint
/v1/customers/business

### Request Body
- **business_name** (string) - Required - Legal name of the business
- **jurisdiction** (string) - Required - Country of incorporation
- **registration_number** (string) - Required - Official business registration ID

### Request Example
{
  "business_name": "Acme Corp",
  "jurisdiction": "US",
  "registration_number": "123456789"
}

### Response
#### Success Response (201)
- **id** (string) - Unique identifier for the business customer
- **status** (string) - Initial verification status

#### Response Example
{
  "id": "cust_abc123",
  "status": "pending"
}
```

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

### Initiate Individual KYC Verification Workflow

Source: https://docs.swipelux.com/individual-onboarding

This sequence of API calls demonstrates the standard workflow for onboarding a new customer. It covers customer creation, initiating the KYC process, and retrieving the current verification status.

```HTTP
# 1. Create customer
POST /v1/customers

# 2. Initiate KYC verification
POST /v1/customers/{id}/kyc

# 3. Redirect customer to verification URL

# 4. Check status
GET /v1/customers/{id}
```

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

### Get Customer Status API Request

Source: https://docs.swipelux.com/individual-onboarding/api-reference

This snippet shows the GET /v1/customers/{id} endpoint used to retrieve the current status and details of an individual customer. It requires the customer's ID as a path parameter.

```http
GET /v1/customers/{id}
```

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

### POST /v1/customers/{id}/kyc

Source: https://docs.swipelux.com/individual-onboarding

Initiates the KYC verification process for a specific customer.

```APIDOC
## POST /v1/customers/{id}/kyc

### Description
Triggers the KYC verification workflow for an existing customer based on their profile data.

### Method
POST

### Endpoint
/v1/customers/{id}/kyc

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

### Request Example
{
  "level": "standard"
}

### Response
#### Success Response (200)
- **verificationUrl** (string) - URL to redirect the customer for document submission

#### Response Example
{
  "verificationUrl": "https://verify.swipelux.com/session/xyz123"
}
```

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

### Get Business Customer Shareholders - API Response

Source: https://docs.swipelux.com/api-reference/customers/create-business

This snippet illustrates a successful response from the GET /v1/customers/business/:id/shareholders endpoint, returning a list of shareholders associated with a business customer. Each shareholder object contains personal details, ownership information, and address.

```json
{
  "shareholders": [
    {
      "id": "sh_xxx",
      "firstName": "John",
      "lastName": "Smith",
      "birthDate": "1985-03-20",
      "email": "john@example.com",
      "ownershipPercentage": 60,
      "hasControl": true,
      "isSigner": true,
      "isDirector": true,
      "address": {
        "country": "US",
        "streetAddress": "456 Oak Avenue",
        "city": "San Francisco",
        "zip": "94102"
      },
      "attestedOwnershipStructureAt": null,
      "createdAt": "2026-02-04T15:45:52.175Z",
      "updatedAt": "2026-02-04T15:45:52.175Z"
    }
  ]
}
```

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

### POST /v1/customers

Source: https://docs.swipelux.com/individual-onboarding

Creates a new individual customer profile in the Swipelux system.

```APIDOC
## POST /v1/customers

### Description
Creates a new customer record. All fields are optional upon creation.

### Method
POST

### Endpoint
/v1/customers

### Parameters
#### Request Body
- **firstName** (string) - Optional - Customer's first name
- **lastName** (string) - Optional - Customer's last name
- **email** (string) - Optional - Customer's email address
- **phone** (string) - Optional - Phone number in E.164 format
- **birthDate** (date) - Optional - Date of birth (YYYY-MM-DD)

### Request Example
{
  "firstName": "John",
  "lastName": "Doe",
  "email": "john.doe@example.com"
}

### Response
#### Success Response (201)
- **id** (string) - The unique identifier for the created customer

#### Response Example
{
  "id": "cust_123456789"
}
```

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

### GET /websites/swipelux/customers/{id}

Source: https://docs.swipelux.com/api-reference/customers/get-by-id

Retrieve detailed information about a specific customer by their unique identifier.

```APIDOC
## GET /websites/swipelux/customers/{id}

### Description
Retrieve detailed information about a specific customer by their unique identifier.

### Method
GET

### Endpoint
/websites/swipelux/customers/{id}

### Parameters
#### Path Parameters
- **id** (string) - Required - The customer ID (e.g., `cus_abc123` for individuals or `biz_def456` for businesses)

### Request Example
```json
{
  "example": "No request body for GET request"
}
```

### Response
#### Success Response (200)
- **id** (string) - The unique identifier of the customer.
- **name** (string) - The name of the customer.
- **email** (string) - The email address of the customer.

#### Response Example
```json
{
  "id": "cus_abc123",
  "name": "John Doe",
  "email": "john.doe@example.com"
}
```
```

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

### Create Customer

Source: https://docs.swipelux.com/api-reference/customers

Create a new customer account. Supports both individual (`cus_xxx`) and business (`biz_xxx`) types. Can be used for quick creation without KYC or with existing KYC data.

```APIDOC
## POST /customers

### Description
Create a new customer account. Supports both individual (`cus_xxx`) and business (`biz_xxx`) types.

### Method
POST

### Endpoint
/customers

### Parameters
#### Request Body
- **type** (string) - Optional - The type of customer, either "individual" (default) or "business".
- **shareToken** (string) - Optional - A token for importing existing KYC data from SumSub.

### Request Example
```json
{
  "type": "business",
  "shareToken": "tok_abc123"
}
```

### Response
#### Success Response (200)
- **customerId** (string) - The unique identifier for the created customer.
- **type** (string) - The type of the created customer.

#### Response Example
```json
{
  "customerId": "cus_xyz789",
  "type": "individual"
}
```
```

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

### Manage Customer KYC via SumSub ShareToken

Source: https://docs.swipelux.com/customer-management

Demonstrates the workflow for initializing a customer and updating their profile with a SumSub share token for identity verification. This process is essential for compliance in crypto-enabled operations.

```HTTP
# 1. Create customer with minimal data
POST /v1/customers {"email": "user@example.com"}
 
# 2. PUT with shareToken (repeat as tokens expire)
PUT /v1/customers/{id} {"shareToken": "sumsub_token_xyz"}
```

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

### POST /v1/customers/business

Source: https://docs.swipelux.com/compliance/merchant-onboarding

Create a new business customer profile to initiate the KYB verification process.

```APIDOC
## POST /v1/customers/business

### Description
Creates a new business entity record. This is the initial step for KYB verification.

### Method
POST

### Endpoint
/v1/customers/business

### Parameters
#### Request Body
- **firstName** (string) - Required - First name of the primary contact
- **lastName** (string) - Required - Last name of the primary contact
- **email** (string) - Required - Email address of the primary contact
- **entityName** (string) - Required - Legal entity name
- **jurisdiction** (string) - Required - Country of jurisdiction (ISO 3166-1 alpha-2)

### Request Example
{
  "firstName": "John",
  "lastName": "Doe",
  "email": "john@example.com",
  "entityName": "Acme Corp",
  "jurisdiction": "US"
}

### Response
#### Success Response (200)
- **id** (string) - The unique identifier for the created business customer

#### Response Example
{
  "id": "bus_123456789"
}
```

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

### GET /v1/customers/business/:id/shareholders

Source: https://docs.swipelux.com/api-reference/customers/create-business

Retrieves a list of all shareholders associated with a specific business customer.

```APIDOC
## GET /v1/customers/business/:id/shareholders

### Description
Returns all shareholders for the business customer.

### Method
GET

### Endpoint
/v1/customers/business/:id/shareholders

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

#### Query Parameters
None

### Response
#### Success Response (200 OK)
- **shareholders** (array) - An array of shareholder objects.
  - **id** (string) - Unique identifier for the shareholder.
  - **firstName** (string) - First name of the shareholder.
  - **lastName** (string) - Last name of the shareholder.
  - **birthDate** (string) - Birth date of the shareholder (YYYY-MM-DD).
  - **email** (string) - Email address of the shareholder.
  - **ownershipPercentage** (number) - Percentage of ownership.
  - **hasControl** (boolean) - Indicates if the shareholder has control.
  - **isSigner** (boolean) - Indicates if the shareholder is a signer.
  - **isDirector** (boolean) - Indicates if the shareholder is a director.
  - **address** (object) - Address details of the shareholder.
    - **country** (string) - Country (ISO 3166-1 alpha-2).
    - **streetAddress** (string) - Street address.
    - **city** (string) - City.
    - **zip** (string) - Postal/ZIP code.
  - **attestedOwnershipStructureAt** (string|null) - Timestamp of attested ownership structure.
  - **createdAt** (string) - Timestamp when the shareholder record was created.
  - **updatedAt** (string) - Timestamp when the shareholder record was last updated.

#### Response Example
```json
{
  "shareholders": [
    {
      "id": "sh_xxx",
      "firstName": "John",
      "lastName": "Smith",
      "birthDate": "1985-03-20",
      "email": "john@example.com",
      "ownershipPercentage": 60,
      "hasControl": true,
      "isSigner": true,
      "isDirector": true,
      "address": {
        "country": "US",
        "streetAddress": "456 Oak Avenue",
        "city": "San Francisco",
        "zip": "94102"
      },
      "attestedOwnershipStructureAt": null,
      "createdAt": "2026-02-04T15:45:52.175Z",
      "updatedAt": "2026-02-04T15:45:52.175Z"
    }
  ]
}
```
```

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

### GET /v1/meta/kyb/documents

Source: https://docs.swipelux.com/business-onboarding/documents

Fetches the required document types for KYB verification, organized by country.

```APIDOC
## GET /v1/meta/kyb/documents

### Description
This endpoint retrieves a list of document types required for Know Your Business (KYB) verification, categorized by jurisdiction. It helps businesses understand what documentation is needed for onboarding based on their country of operation.

### Method
GET

### Endpoint
/v1/meta/kyb/documents

### Parameters
#### Query Parameters
None

### Request Example
```json
{
  "example": "GET /v1/meta/kyb/documents"
}
```

### Response
#### Success Response (200)
- **US** (object) - Information for United States jurisdiction.
  - **requested_types** (array of strings) - List of document types required for KYB verification in the US.
- **GB** (object) - Information for Great Britain jurisdiction.
  - **requested_types** (array of strings) - List of document types required for KYB verification in GB.
- **DE** (object) - Information for Germany jurisdiction.
  - **requested_types** (array of strings) - List of document types required for KYB verification in DE.

#### Response Example
```json
{
  "US": {
    "requested_types": [
      "certificate_of_incorporation",
      "power_of_attorney",
      "corporate_structure",
      "director_structure",
      "proof_of_address"
    ]
  },
  "GB": {
    "requested_types": [
      "certificate_of_incorporation",
      "proof_of_address",
      "corporate_structure",
      "director_structure"
    ]
  },
  "DE": {
    "requested_types": [
      "certificate_of_incorporation",
      "proof_of_address",
      "corporate_structure",
      "director_structure"
    ]
  }
}
```
```

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

### Create Customer

Source: https://docs.swipelux.com/api-reference/customers/create

This endpoint creates both individual and business customers. Use the `type` parameter to specify the customer type, which defaults to 'individual'. Optional KYC information can be included using a SumSub share token.

```APIDOC
## POST /websites/swipelux/customers

### Description
Creates individual or business customers with optional KYC information.

### Method
POST

### Endpoint
/websites/swipelux/customers

### Parameters
#### Query Parameters
- **type** (string) - Optional - Specifies whether to create an individual or business customer. Values: `"individual"` (default) or `"business"`.
- **shareToken** (string) - Optional - A SumSub share token for importing existing KYC verification data.

### Request Example
```json
{
  "type": "individual",
  "shareToken": "your_sumsub_share_token"
}
```

### Response
#### Success Response (200)
- **id** (string) - The unique identifier for the created customer (e.g., `cus_` for individual, `biz_` for business).
- **type** (string) - The type of customer created (`"individual"` or `"business"`).
- **kyc_status** (string) - The KYC verification status if a `shareToken` was provided.

#### Response Example
```json
{
  "id": "cus_abcdef123456",
  "type": "individual",
  "kyc_status": "verified"
}
```
```

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

### GET /customers/{id}/balance

Source: https://docs.swipelux.com/api-reference/customers/get-balance

Retrieve the balance information for a specific customer across all their associated wallets and blockchain networks.

```APIDOC
## GET /customers/{id}/balance

### Description
Retrieve balance information for a customer across all their wallets and blockchain networks. This is useful for displaying wallet UI, performing financial reconciliation, or verifying funds before transfers.

### Method
GET

### Endpoint
/customers/{id}/balance

### Parameters
#### Path Parameters
- **id** (string) - Required - The unique customer ID to retrieve balances for.

### Request Example
GET /customers/cust_12345/balance

### Response
#### Success Response (200)
- **balances** (array) - List of balance objects per wallet/network
- **total_balance** (number) - Aggregated balance across all networks

#### Response Example
{
  "customer_id": "cust_12345",
  "total_balance": 150.50,
  "balances": [
    {
      "network": "ethereum",
      "amount": 0.05
    },
    {
      "network": "bitcoin",
      "amount": 0.002
    }
  ]
}
```

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

### Get Customer Status

Source: https://docs.swipelux.com/individual-onboarding/api-reference

Retrieves the current customer record, including their verification status.

```APIDOC
## GET /v1/customers/{id}

### Description
Retrieves the current customer record including verification status.

### Method
GET

### Endpoint
/v1/customers/{id}

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

### Response
#### Success Response (200)
- **id** (string) - The unique identifier for the customer.
- **type** (string) - The type of customer ('individual').
- **firstName** (string) - The first name of the individual.
- **lastName** (string) - The last name of the individual.
- **email** (string) - The email address of the individual.
- **status** (string) - The current verification status (e.g., 'approved').
- **createdAt** (string) - The timestamp when the customer record was created.
- **updatedAt** (string) - The timestamp when the customer record was last updated.

#### Response Example
```json
{
  "id": "cust_abc123",
  "type": "individual",
  "firstName": "John",
  "lastName": "Doe",
  "email": "john.doe@example.com",
  "status": "approved",
  "createdAt": "2024-01-15T10:30:00Z",
  "updatedAt": "2024-01-15T14:30:00Z"
}
```
```

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

### POST /v1/customers/business

Source: https://docs.swipelux.com/core-flow/customers/business

Creates a new business customer record with associated KYB documentation and shareholder information.

```APIDOC
## POST /v1/customers/business

### Description
Creates a new business customer with complete KYB information. This endpoint registers the business entity and its representative, requiring extensive documentation for compliance.

### Method
POST

### Endpoint
/v1/customers/business

### Parameters
#### Request Body
- **firstName** (string) - Required - First name of the representative
- **lastName** (string) - Required - Last name of the representative
- **birthDate** (string) - Required - Birth date of the representative (YYYY-MM-DD)
- **email** (string) - Required - Contact email
- **phone** (string) - Required - Contact phone number
- **jurisdiction** (string) - Required - Country code of business registration
- **entityType** (string) - Required - Type of business entity (e.g., LLC)
- **entityName** (string) - Required - Legal name of the business
- **tradeName** (string) - Required - Business trade name
- **registrationNumber** (string) - Required - Business registration ID
- **taxNumber** (string) - Required - Tax identification number
- **businessDescription** (string) - Required - Detailed description of business activities
- **businessType** (string) - Required - Industry or business category
- **websites** (array) - Required - List of business website URLs
- **phoneNumber** (string) - Required - Business phone number
- **addressCountry** (string) - Required - Business country
- **streetAddress** (string) - Required - Business street address
- **city** (string) - Required - Business city
- **state** (string) - Required - Business state
- **zip** (string) - Required - Business postal code
- **sourceOfFunds** (string) - Required - Primary source of business revenue
- **expectedMonthlyVolumeUsd** (number) - Required - Projected monthly transaction volume
- **purposeOfFunds** (string) - Required - Intended use of funds
- **flowOfFundsDescription** (string) - Required - Description of financial flows
- **sanctionedCountryOperations** (boolean) - Required - Flag for operations in sanctioned regions
- **documents** (array) - Required - List of KYB supporting documents
- **shareholders** (array) - Required - List of business shareholders and their details

### Request Example
{
  "firstName": "John",
  "lastName": "Smith",
  "entityName": "Acme Corporation LLC",
  "jurisdiction": "US",
  "businessDescription": "Software development services"
}

### Response
#### Success Response (200)
- **id** (string) - The unique identifier of the created business customer
- **status** (string) - Current verification status

#### Response Example
{
  "id": "cust_123456789",
  "status": "pending_verification"
}
```

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

### Create Individual Customer with KYC Import

Source: https://docs.swipelux.com/core-flow/customers/individual

Illustrates creating an individual customer by importing existing KYC verification data using a SumSub share token. This can skip redundant verification steps.

```json
{
  "firstName": "John",
  "lastName": "Doe",
  "email": "john@example.com",
  "shareToken": "sumsub_token_xyz"
}
```

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

### GET /websites/swipelux/webhooks

Source: https://docs.swipelux.com/api-reference/webhooks/get

Retrieve the current webhook configuration for your merchant account, including the endpoint URL, subscribed events, and signing secret.

```APIDOC
## GET /websites/swipelux/webhooks

### Description
Retrieve the current webhook configuration for your merchant account, including the endpoint URL, subscribed events, and signing secret.

### Method
GET

### Endpoint
/websites/swipelux/webhooks

### Parameters
#### Query Parameters
None

#### Request Body
None

### Response
#### Success Response (200)
- **endpoint_url** (string) - The URL where webhooks will be sent.
- **subscribed_events** (array) - A list of events the merchant is subscribed to.
- **signing_secret** (string) - The secret used to sign webhook requests.

#### Response Example
```json
{
  "endpoint_url": "https://example.com/webhook",
  "subscribed_events": [
    "order.created",
    "order.updated"
  ],
  "signing_secret": "your_signing_secret"
}
```
```

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

### Get Customer Balance

Source: https://docs.swipelux.com/api-reference/customers

Retrieve balance information for a customer across all wallets. Useful for displaying balances, reconciliation, or verifying sufficient funds before transfers.

```APIDOC
## GET /customers/{customerId}/balance

### Description
Retrieve balance information for a customer across all wallets.

### Method
GET

### Endpoint
/customers/{customerId}/balance

### Parameters
#### Path Parameters
- **customerId** (string) - Required - The unique identifier of the customer whose balance to retrieve.

### Response
#### Success Response (200)
- **balances** (array) - An array of balance objects for different currencies/chains.
  - **currency** (string) - The currency or chain of the balance.
  - **amount** (string) - The balance amount.

#### Response Example
```json
{
  "balances": [
    {
      "currency": "USD",
      "amount": "100.50"
    },
    {
      "currency": "ETH",
      "amount": "2.75"
    }
  ]
}
```
```
Tokens:
Raw