SIsivo
Accounts

Create or update (upsert) an account

Changed on
post/accounts

Request

  • Base URL
    https://core.sivo.com
  • Auth
    • API key in header Authorization
    • or OAuth 2
      Authorization codehttps://dashboard.sivo.com/oauth/authorize
      Client credentials
      Token URLhttps://core.sivo.com/oauth/token
  • TypeScript
    A function with typed inputs. Its response is checked against the schema.

Headers

Idempotency-Keystring

A unique key per operation, could be V4 UUID or other high‑entropy random string. Keys can be up to 256 bytes. See Idempotent Requests.

Example:978771af-77de-4e24-ba39-f602502ceb78

Request body

idstring required

The account ID assigned by the originator

namestring

Display name of the account. Required at creation unless first_name or last_name is provided, in which case it defaults to them joined; optional for updates.

type'business' | 'individual'

Legal classification of the seller entity. Required at creation, optional for updates.

first_namestring nullable

First (given) name of an individual

last_namestring nullable

Last (family) name of an individual

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

{
  "id": "acct-123",
  "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

first_namestring

First (given) name of an individual

last_namestring

Last (family) name of an individual

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

The account ID assigned by the originator

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": "acct-123",
  "created_at": "2024-01-15T10:30:00Z",
  "created_by": "user_0123456789ABCDEFGHIJKLMNOPq",
  "updated_at": "2024-01-15T10:30:00Z",
  "updated_by": "user_0123456789ABCDEFGHIJKLMNOPq"
}

Changes

  • 4bbab9699612Revision changes
    • breaking

      added the new required request property

    • breaking

      added to the response property oneOf list for the response status

    • breaking

      added to the response property oneOf list for the response status

    • warning

      deleted the header request parameter IdempotencyKey

    • info

      added the new optional header request parameter Idempotency-Key

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      the request property became nullable

    • info

      the request property became nullable

    • info

      the request property became nullable

    • info

      the request property became nullable

    • info

      the request property became nullable

    • info

      the request property became nullable

    • info

      the request property became nullable

    • info

      the request property became nullable

    • info

      the request property became nullable

    • info

      the request property became nullable

    • info

      the request property became nullable

    • info

      the request property became nullable

    • info

      the request property became nullable

    • info

      the request property became nullable

    • info

      the request property became nullable

    • info

      the request property became nullable

    • info

      the request property became nullable

    • info

      the request property became nullable

    • info

      the request property became nullable

    • info

      the request property became optional

    • info

      the request property became optional

    • info

      added the new undefined enum value to the request property

    • info

      added subschema #5 to the request property oneOf list

    • info

      added subschema #9 to the request property oneOf list

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      the response's property pattern was changed from ^[a-z]{3,7}_[0-9A-Za-z]{27}$ to ^[0-9A-Za-z_-]{1,255}$ for the status

    • info

      the response's property pattern was changed from ^[a-z]{3,7}_[0-9A-Za-z]{27}$ to ^[0-9A-Za-z_-]{1,255}$ for the status

    • info

      the response's property pattern ^[a-z]{3,7}_[0-9A-Za-z]{27}$ was removed for the status