Sign in

v1

latestOpenAPI 3.1.02026-07-247328324.6 KB
Accounts

Update an account

patch/accounts/{id}

Path parameters

idstring required

An object id with prefix

Example:user_0123456789ABCDEFGHIJKLMNOPq

An object id with prefix

Headers

if-matchstring date-time required

ETag value for Optimistic Concurrency Control (OCC). Should contain the last known updated_at timestamp in ISO 8601 format.

Example:2024-01-15T10:30:00Z

ETag value for Optimistic Concurrency Control (OCC). Should contain the last known updated_at timestamp in ISO 8601 format.

Request body

namestring

Non-empty text string

type'business' | 'individual'

Legal classification of the seller entity

websitestring nullable

Seller website

emailstring email nullable

Contact email address for the seller

phonestring nullable

Contact phone number for the seller

industrystring nullable

NAICS industry code: https://www.naics.com/search/

kyx_status'draft' | 'submitted' | 'approved' | 'rejected' | 'null' nullable

Know Your Customer verification status

active_sincestring date nullable

Date when the seller was first active in the platform

monthly_revenueinteger nullable

Monthly revenue of the seller in USD

monthly_costsinteger nullable

Monthly costs of the seller in USD

cash_on_handinteger nullable

Cash on hand of the seller in USD

avg_sale_sizeinteger nullable

Average sale size of the seller in USD

performance_scoreinteger nullable

Performance score between 1 (poor) and 10 (excellent)

buyer_concentrationnumber nullable

Percentage of total revenue from the top 20% of buyers

average_days_to_payinteger nullable

Average days to pay

lifetime_spendinteger nullable

Total amount spent by the buyer in USD

customer_countinteger nullable

Number of customers

metadataobject nullable

Additional custom data associated with this seller

Example request

{
  "website": "https://acme.com",
  "email": "email@domain.com",
  "phone": "+14155551234",
  "industry": "541511",
  "legal_entity_id": "duns:123456789",
  "credit_score": "paydex:123",
  "active_since": "2024-01-15",
  "monthly_revenue": 10000,
  "monthly_costs": 10000,
  "cash_on_hand": 10000,
  "avg_sale_size": 10000,
  "buyer_concentration": 0.05,
  "average_days_to_pay": 42,
  "lifetime_spend": 10000,
  "customer_count": 42,
  "insurance": {
    "rating": "coface:8",
    "limit": 10000,
    "coverage": 0.05
  },
  "metadata": {
    "key": "value"
  }
}

Response

Successful operation

namestring required

Non-empty text string

type'business' | 'individual' required

Legal classification of the seller entity

websitestring

Seller website

emailstring email

Contact email address for the seller

phonestring

Contact phone number for the seller

industrystring

NAICS industry code: https://www.naics.com/search/

kyx_status'draft' | 'submitted' | 'approved' | 'rejected'

Know Your Customer verification status

active_sincestring date

Date when the seller was first active in the platform

monthly_revenueinteger

Monthly revenue of the seller in USD

monthly_costsinteger

Monthly costs of the seller in USD

cash_on_handinteger

Cash on hand of the seller in USD

avg_sale_sizeinteger

Average sale size of the seller in USD

performance_scoreinteger

Performance score between 1 (poor) and 10 (excellent)

buyer_concentrationnumber

Percentage of total revenue from the top 20% of buyers

average_days_to_payinteger

Average days to pay

lifetime_spendinteger

Total amount spent by the buyer in USD

customer_countinteger

Number of customers

metadataobject

Additional custom data associated with this seller

idstring required

An object id with prefix

created_atstring date-time required

Creation date and time

created_bystring required

ID of the user that created this object

updated_atstring date-time required

Last update date and time

updated_bystring required

ID of the user that last updated this object

Example response

{
  "website": "https://acme.com",
  "email": "email@domain.com",
  "phone": "+14155551234",
  "industry": "541511",
  "legal_entity_id": "duns:123456789",
  "credit_score": "paydex:123",
  "active_since": "2024-01-15",
  "monthly_revenue": 10000,
  "monthly_costs": 10000,
  "cash_on_hand": 10000,
  "avg_sale_size": 10000,
  "buyer_concentration": 0.05,
  "average_days_to_pay": 42,
  "lifetime_spend": 10000,
  "customer_count": 42,
  "insurance": {
    "rating": "coface:8",
    "limit": 10000,
    "coverage": 0.05
  },
  "metadata": {
    "key": "value"
  },
  "id": "user_0123456789ABCDEFGHIJKLMNOPq",
  "created_at": "2024-01-15T10:30:00Z",
  "created_by": "user_0123456789ABCDEFGHIJKLMNOPq",
  "updated_at": "2024-01-15T10:30:00Z",
  "updated_by": "user_0123456789ABCDEFGHIJKLMNOPq"
}