Skip to main content
PATCH
/
api
/
v2
/
entity
Update entity
curl --request PATCH \
  --url https://demo.api.loopcrypto.xyz/api/v2/entity \
  --header 'Content-Type: application/json' \
  --header 'api-key: <api-key>' \
  --header 'entity-id: <api-key>' \
  --data '{
  "entityName": "Loop Inc.",
  "email": "info@loopcrypto.com",
  "logoUrl": "https://loopcrypto.xyz/logo.png"
}'
{
  "entityId": "1234567890abcdef",
  "entityName": "Loop Inc.",
  "email": "info@loop.com",
  "contracts": [
    {
      "networkId": 1,
      "contractAddress": "0xdAC17F958D2ee523a2206206994597C13D831ec7"
    }
  ],
  "payoutDestinations": [
    {
      "networkId": 1,
      "walletAddress": "0x1234567890abcdef",
      "isDefault": true,
      "payoutDestinationId": "1234567890abcdef",
      "settlementType": "Crypto"
    }
  ],
  "fiatSettlementAccount": {
    "provider": "Fern",
    "kycStatus": "pending",
    "kycLink": "https://www.google.com",
    "bankAccountStatus": "Pending",
    "bankAccountFormLink": "https://www.google.com"
  },
  "paymentTypes": [
    {
      "symbol": "USDC",
      "networkId": 1,
      "tokenId": "d9e1f2a3-b4c5-6d7e-8f9g-0h1i2j3k4l5m",
      "address": "0xa0b86991c6218b36c1d19d4a2e9eb0ce3606eb48",
      "decimals": 6,
      "isDefault": true
    }
  ]
}

Authorizations

​
api-key
string
header
required
​
entity-id
string
header
required

Body

application/json
​
entityName
string

(Optional) The new name to update for the organization. If not provided, the existing name will be kept unchanged

Example:

"Loop Inc."

​
email
string

(Optional) The new email address to update for entity communications and notifications. If not provided, the existing email will be kept unchanged

Example:

"info@loopcrypto.com"

​
logoUrl
string

(Optional) The URL of the logo to update for the organization. If not provided, the existing logo will be kept unchanged

Example:

"https://loopcrypto.xyz/logo.png"

Response

Ok

​
entityId
string
required

The unique identifier for the entity

Example:

"1234567890abcdef"

​
entityName
string
required

The name that identifies the organization

Example:

"Loop Inc."

​
email
string
required

The primary contact email address used for entity communications and notifications

Example:

"info@loop.com"

​
contracts
object[]
required

A list of contract addresses deployed across different networks for this entity

​
payoutDestinations
object[]
required

The payout destinations supported by the organization

​
fiatSettlementAccount
object
required

The fiat settlement configuration for the entity when fiat settlement is enabled for any payout destination

​
paymentTypes
object[]
required

The payment types supported by the organization

⌘I