Get User

GET

api

users

{uuid}

{
  "client_reference_id": "company_45458",
  "uuid": "9d264b4a-006c-4d01-acd0-730e27784c59",
  "first_name": "John",
  "last_name": "Dew",
  "email": "[email protected]",
  "phone": "2457856490",
  "business": {
    "name": "John Incorporation",
    "tin": "922454715",
    "address_type": "Registered",
    "address": {
      "street_address": "10554 W Quarles Ave",
      "city": "Littleton",
      "state": "CO",
      "country": "US",
      "zip": "80127"
    },
    "trading_name": "John Incorporation",
    "entity_type": "Sole Trader",
    "incorporation_date": "2024-02-02",
    "incorporation_state": "CO",
    "industry": "Nature of business",
    "industry_classification": {
      "code_type": "SIC",
      "codes": [
        "NAICS 42",
        "NAICS 45"
      ],
      "description": "NAICS"
    },
    "source_of_wealth": "2344",
    "source_of_funds": "Industry",
    "first_transaction_completed_at": "2024-05-02 16:14:25",
    "product_type": "financial",
    "registered_as_inactive": false
  },
  "user_status": "APPROVED",
  "kyb_status": "APPROVED",
  "kyb_rejected_reason": null,
  "financing_credit_balance": null,
  "role": "business",
  "vendor_name": "Fintech",
  "business_owners": [
    {
      "first_name": "John",
      "last_name": "Dew",
      "dob": "2023-04-11",
      "ssn9": "123456789",
      "address_line_1": "10554 W Quarles Ave",
      "city": "Littleton",
      "state": "CO",
      "zip": "80127",
      "is_beneficial_owner": true,
      "is_director": false,
      "is_account_owner": false,
      "is_share_holder": false,
      "is_significant_control_person": false,
      "ownership_percentage": 25,
      "email": "[email protected]",
      "phone": "2457856490",
      "nationality": "US",
      "occupation": "Co-founder",
      "first_transaction_completed_at": "2024-05-02 16:14:25",
      "product_type": "financial"
    }
  ],
  "created_at": "2024-10-02 14:06:14",
  "updated_at": "2024-10-02 14:06:17"
}

Authorizations

Authorization

string

header

required

Sanctum token-based authentication using the Bearer scheme.

Path Parameters

uuid

string

required

User UUID

Response

200

application/json

User details retrieved successfully

Schema for a Business response

client_reference_id

string

Example:

"company_45458"

uuid

string

Example:

"9d264b4a-006c-4d01-acd0-730e27784c59"

first_name

string

Example:

"John"

last_name

string

Example:

"Dew"

string

Example:

"[email protected]"

phone

string

Example:

"2457856490"

business

object

business.name

string

Example:

"John Incorporation"

business.tin

string

Example:

"922454715"

business.address_type

string

Example:

"Registered"

business.address

object

business.trading_name

string

Example:

"John Incorporation"

business.entity_type

string

Example:

"Sole Trader"

business.incorporation_date

string

Example:

"2024-02-02"

business.incorporation_state

string

Example:

"CO"

business.industry

string

Example:

"Nature of business"

business.industry_classification

object

business.industry_classification.code_type

string

Example:

"SIC"

business.industry_classification.codes

string[]

Example:

["NAICS 42", "NAICS 45"]

business.industry_classification.description

string

Example:

"NAICS"

business.source_of_wealth

string

Example:

"2344"

business.source_of_funds

string

Example:

"Industry"

business.first_transaction_completed_at

string

Example:

"2024-05-02 16:14:25"

business.product_type

string

Example:

"financial"

business.registered_as_inactive

boolean

Example:

false

user_status

string

Example:

"APPROVED"

kyb_status

string

Example:

"APPROVED"

kyb_rejected_reason

string | null

Example:

null

financing_credit_balance

number | null

Example:

null

role

string

Example:

"business"

vendor_name

string

Example:

"Fintech"

business_owners

object[]

created_at

string

Example:

"2024-10-02 14:06:14"

updated_at

string

Example:

"2024-10-02 14:06:17"

Schema for a Business response

client_reference_id

string

Example:

"company_45458"

uuid

string

Example:

"9d264b4a-006c-4d01-acd0-730e27784c59"

first_name

string

Example:

"John"

last_name

string

Example:

"Dew"

string

Example:

"[email protected]"

phone

string

Example:

"2457856490"

business

object

business.name

string

Example:

"John Incorporation"

business.tin

string

Example:

"922454715"

business.address_type

string

Example:

"Registered"

business.address

object

business.trading_name

string

Example:

"John Incorporation"

business.entity_type

string

Example:

"Sole Trader"

business.incorporation_date

string

Example:

"2024-02-02"

business.incorporation_state

string

Example:

"CO"

business.industry

string

Example:

"Nature of business"

business.industry_classification

object

business.industry_classification.code_type

string

Example:

"SIC"

business.industry_classification.codes

string[]

Example:

["NAICS 42", "NAICS 45"]

business.industry_classification.description

string

Example:

"NAICS"

business.source_of_wealth

string

Example:

"2344"

business.source_of_funds

string

Example:

"Industry"

business.first_transaction_completed_at

string

Example:

"2024-05-02 16:14:25"

business.product_type

string

Example:

"financial"

business.registered_as_inactive

boolean

Example:

false

user_status

string

Example:

"APPROVED"

kyb_status

string

Example:

"APPROVED"

kyb_rejected_reason

string | null

Example:

null

financing_credit_balance

number | null

Example:

null

role

string

Example:

"business"

vendor_name

string

Example:

"Fintech"

business_owners

object[]

created_at

string

Example:

"2024-10-02 14:06:14"

updated_at

string

Example:

"2024-10-02 14:06:17"

Schema for a person response

status

boolean

Response status

message

string

Response message

data

object

User data

errors

object | null

Error details if any

error_code

string | null

Error code if any

Get Transaction List Deleting a User

{
  "client_reference_id": "company_45458",
  "uuid": "9d264b4a-006c-4d01-acd0-730e27784c59",
  "first_name": "John",
  "last_name": "Dew",
  "email": "[email protected]",
  "phone": "2457856490",
  "business": {
    "name": "John Incorporation",
    "tin": "922454715",
    "address_type": "Registered",
    "address": {
      "street_address": "10554 W Quarles Ave",
      "city": "Littleton",
      "state": "CO",
      "country": "US",
      "zip": "80127"
    },
    "trading_name": "John Incorporation",
    "entity_type": "Sole Trader",
    "incorporation_date": "2024-02-02",
    "incorporation_state": "CO",
    "industry": "Nature of business",
    "industry_classification": {
      "code_type": "SIC",
      "codes": [
        "NAICS 42",
        "NAICS 45"
      ],
      "description": "NAICS"
    },
    "source_of_wealth": "2344",
    "source_of_funds": "Industry",
    "first_transaction_completed_at": "2024-05-02 16:14:25",
    "product_type": "financial",
    "registered_as_inactive": false
  },
  "user_status": "APPROVED",
  "kyb_status": "APPROVED",
  "kyb_rejected_reason": null,
  "financing_credit_balance": null,
  "role": "business",
  "vendor_name": "Fintech",
  "business_owners": [
    {
      "first_name": "John",
      "last_name": "Dew",
      "dob": "2023-04-11",
      "ssn9": "123456789",
      "address_line_1": "10554 W Quarles Ave",
      "city": "Littleton",
      "state": "CO",
      "zip": "80127",
      "is_beneficial_owner": true,
      "is_director": false,
      "is_account_owner": false,
      "is_share_holder": false,
      "is_significant_control_person": false,
      "ownership_percentage": 25,
      "email": "[email protected]",
      "phone": "2457856490",
      "nationality": "US",
      "occupation": "Co-founder",
      "first_transaction_completed_at": "2024-05-02 16:14:25",
      "product_type": "financial"
    }
  ],
  "created_at": "2024-10-02 14:06:14",
  "updated_at": "2024-10-02 14:06:17"
}

Bank Account

Business,Merchant

Billing

Payouts

Refunds

Transaction

Users

Webhook

Processor

Onboard Person

Authorizations

Path Parameters

Response