Update an entity account's company details

curl --request PATCH \
  --url https://api.byzantine.fi/v1/submit/update-entity-account \
  --header 'Content-Type: application/json' \
  --header 'X-Pubkey: <x-pubkey>' \
  --header 'X-Pubkey, X-Timestamp, X-Signature: <api-key>' \
  --header 'X-Signature: <x-signature>' \
  --header 'X-Timestamp: <x-timestamp>' \
  --data '
{
  "accountId": "550e8400-e29b-41d4-a716-446655440000",
  "entityInfo": {
    "businessLegalName": "ByzCorp Incorporated",
    "businessTradeName": "ByzCorp",
    "businessType": "llc",
    "companyNumber": "123456789",
    "email": "byzcorp@example.com",
    "website": "byzcorp.com",
    "logoUrl": "https://byzcorp.com/logo.png",
    "registeredAddress": {
      "streetLine1": "33 Rue La Fayette",
      "city": "Paris",
      "postalCode": "75009",
      "country": "FRA",
      "streetLine2": "WeWork",
      "state": "IDF"
    },
    "physicalAddress": {
      "streetLine1": "33 Rue La Fayette",
      "city": "Paris",
      "postalCode": "75009",
      "country": "FRA",
      "streetLine2": "WeWork",
      "state": "IDF"
    },
    "activityInfo": {
      "businessDescription": "ByzCorp does business.",
      "businessIndustry": 523110
    },
    "financialInfo": {
      "sourceOfFunds": "treasury_reserves",
      "estimatedAnnualRevenueUsd": "1000000_9999999",
      "expectedMonthlyPaymentsUsd": 5000000,
      "hasMaterialIntermediaryEntityOwner": false
    },
    "highRiskInfo": {
      "operatesInProhibitedCountries": false,
      "highRiskActivities": "none_of_the_above",
      "highRiskActivitiesExplanation": "<string>",
      "conductsMoneyServices": false,
      "conductsMoneyServicesDescription": "<string>"
    }
  },
  "entityDocuments": [
    {
      "documentType": "incorporation_cert",
      "issuingCountry": "FRA",
      "document": "data:image/png;base64,iVBORw0lFTkSuQmCC...",
      "description": "An overview of our business activities."
    }
  ]
}
'

import requests

url = "https://api.byzantine.fi/v1/submit/update-entity-account"

payload = {
    "accountId": "550e8400-e29b-41d4-a716-446655440000",
    "entityInfo": {
        "businessLegalName": "ByzCorp Incorporated",
        "businessTradeName": "ByzCorp",
        "businessType": "llc",
        "companyNumber": "123456789",
        "email": "byzcorp@example.com",
        "website": "byzcorp.com",
        "logoUrl": "https://byzcorp.com/logo.png",
        "registeredAddress": {
            "streetLine1": "33 Rue La Fayette",
            "city": "Paris",
            "postalCode": "75009",
            "country": "FRA",
            "streetLine2": "WeWork",
            "state": "IDF"
        },
        "physicalAddress": {
            "streetLine1": "33 Rue La Fayette",
            "city": "Paris",
            "postalCode": "75009",
            "country": "FRA",
            "streetLine2": "WeWork",
            "state": "IDF"
        },
        "activityInfo": {
            "businessDescription": "ByzCorp does business.",
            "businessIndustry": 523110
        },
        "financialInfo": {
            "sourceOfFunds": "treasury_reserves",
            "estimatedAnnualRevenueUsd": "1000000_9999999",
            "expectedMonthlyPaymentsUsd": 5000000,
            "hasMaterialIntermediaryEntityOwner": False
        },
        "highRiskInfo": {
            "operatesInProhibitedCountries": False,
            "highRiskActivities": "none_of_the_above",
            "highRiskActivitiesExplanation": "<string>",
            "conductsMoneyServices": False,
            "conductsMoneyServicesDescription": "<string>"
        }
    },
    "entityDocuments": [
        {
            "documentType": "incorporation_cert",
            "issuingCountry": "FRA",
            "document": "data:image/png;base64,iVBORw0lFTkSuQmCC...",
            "description": "An overview of our business activities."
        }
    ]
}
headers = {
    "X-Pubkey": "<x-pubkey>",
    "X-Timestamp": "<x-timestamp>",
    "X-Signature": "<x-signature>",
    "X-Pubkey, X-Timestamp, X-Signature": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.patch(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'PATCH',
  headers: {
    'X-Pubkey': '<x-pubkey>',
    'X-Timestamp': '<x-timestamp>',
    'X-Signature': '<x-signature>',
    'X-Pubkey, X-Timestamp, X-Signature': '<api-key>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    accountId: '550e8400-e29b-41d4-a716-446655440000',
    entityInfo: {
      businessLegalName: 'ByzCorp Incorporated',
      businessTradeName: 'ByzCorp',
      businessType: 'llc',
      companyNumber: '123456789',
      email: 'byzcorp@example.com',
      website: 'byzcorp.com',
      logoUrl: 'https://byzcorp.com/logo.png',
      registeredAddress: {
        streetLine1: '33 Rue La Fayette',
        city: 'Paris',
        postalCode: '75009',
        country: 'FRA',
        streetLine2: 'WeWork',
        state: 'IDF'
      },
      physicalAddress: {
        streetLine1: '33 Rue La Fayette',
        city: 'Paris',
        postalCode: '75009',
        country: 'FRA',
        streetLine2: 'WeWork',
        state: 'IDF'
      },
      activityInfo: {businessDescription: 'ByzCorp does business.', businessIndustry: 523110},
      financialInfo: {
        sourceOfFunds: 'treasury_reserves',
        estimatedAnnualRevenueUsd: '1000000_9999999',
        expectedMonthlyPaymentsUsd: 5000000,
        hasMaterialIntermediaryEntityOwner: false
      },
      highRiskInfo: {
        operatesInProhibitedCountries: false,
        highRiskActivities: 'none_of_the_above',
        highRiskActivitiesExplanation: '<string>',
        conductsMoneyServices: false,
        conductsMoneyServicesDescription: '<string>'
      }
    },
    entityDocuments: [
      {
        documentType: 'incorporation_cert',
        issuingCountry: 'FRA',
        document: 'data:image/png;base64,iVBORw0lFTkSuQmCC...',
        description: 'An overview of our business activities.'
      }
    ]
  })
};

fetch('https://api.byzantine.fi/v1/submit/update-entity-account', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "entityId": "550e8400-e29b-41d4-a716-446655440000",
  "accountId": "550e8400-e29b-41d4-a716-446655440000",
  "verificationStatus": "active",
  "entityInfo": {
    "businessLegalName": "ByzCorp Incorporated",
    "businessTradeName": "ByzCorp",
    "businessType": "llc",
    "companyNumber": "123456789",
    "email": "byzcorp@example.com",
    "website": "byzcorp.com",
    "logoUrl": "https://byzcorp.com/logo.png",
    "registeredAddress": {
      "streetLine1": "33 Rue La Fayette",
      "city": "Paris",
      "postalCode": "75009",
      "country": "FRA",
      "streetLine2": "WeWork",
      "state": "IDF"
    },
    "physicalAddress": {
      "streetLine1": "33 Rue La Fayette",
      "city": "Paris",
      "postalCode": "75009",
      "country": "FRA",
      "streetLine2": "WeWork",
      "state": "IDF"
    },
    "activityInfo": {
      "businessDescription": "ByzCorp does business.",
      "businessIndustry": 523110
    },
    "financialInfo": {
      "preferredPrimaryCurrency": "usd",
      "sourceOfFunds": "treasury_reserves",
      "estimatedAnnualRevenueUsd": "1000000_9999999",
      "expectedMonthlyPaymentsUsd": 5000000,
      "hasMaterialIntermediaryEntityOwner": false
    },
    "highRiskInfo": {
      "operatesInProhibitedCountries": false,
      "highRiskActivities": "none_of_the_above",
      "highRiskActivitiesExplanation": "<string>",
      "conductsMoneyServices": false,
      "conductsMoneyServicesDescription": "<string>"
    }
  },
  "entityDocuments": [
    {
      "documentType": "passport",
      "issuingCountry": "FRA",
      "documentId": "830c219c-d197-451d-b879-77936a80c452",
      "documentNumber": "FR1234567890",
      "description": "Additional supporting document",
      "warnings": [
        "<string>"
      ],
      "errors": [
        "<string>"
      ]
    }
  ],
  "missingDocuments": [
    "<string>"
  ],
  "missingCompanyData": [
    "<string>"
  ]
}

PATCH

submit

update-entity-account

Update an entity account's company details

curl --request PATCH \
  --url https://api.byzantine.fi/v1/submit/update-entity-account \
  --header 'Content-Type: application/json' \
  --header 'X-Pubkey: <x-pubkey>' \
  --header 'X-Pubkey, X-Timestamp, X-Signature: <api-key>' \
  --header 'X-Signature: <x-signature>' \
  --header 'X-Timestamp: <x-timestamp>' \
  --data '
{
  "accountId": "550e8400-e29b-41d4-a716-446655440000",
  "entityInfo": {
    "businessLegalName": "ByzCorp Incorporated",
    "businessTradeName": "ByzCorp",
    "businessType": "llc",
    "companyNumber": "123456789",
    "email": "byzcorp@example.com",
    "website": "byzcorp.com",
    "logoUrl": "https://byzcorp.com/logo.png",
    "registeredAddress": {
      "streetLine1": "33 Rue La Fayette",
      "city": "Paris",
      "postalCode": "75009",
      "country": "FRA",
      "streetLine2": "WeWork",
      "state": "IDF"
    },
    "physicalAddress": {
      "streetLine1": "33 Rue La Fayette",
      "city": "Paris",
      "postalCode": "75009",
      "country": "FRA",
      "streetLine2": "WeWork",
      "state": "IDF"
    },
    "activityInfo": {
      "businessDescription": "ByzCorp does business.",
      "businessIndustry": 523110
    },
    "financialInfo": {
      "sourceOfFunds": "treasury_reserves",
      "estimatedAnnualRevenueUsd": "1000000_9999999",
      "expectedMonthlyPaymentsUsd": 5000000,
      "hasMaterialIntermediaryEntityOwner": false
    },
    "highRiskInfo": {
      "operatesInProhibitedCountries": false,
      "highRiskActivities": "none_of_the_above",
      "highRiskActivitiesExplanation": "<string>",
      "conductsMoneyServices": false,
      "conductsMoneyServicesDescription": "<string>"
    }
  },
  "entityDocuments": [
    {
      "documentType": "incorporation_cert",
      "issuingCountry": "FRA",
      "document": "data:image/png;base64,iVBORw0lFTkSuQmCC...",
      "description": "An overview of our business activities."
    }
  ]
}
'

import requests

url = "https://api.byzantine.fi/v1/submit/update-entity-account"

payload = {
    "accountId": "550e8400-e29b-41d4-a716-446655440000",
    "entityInfo": {
        "businessLegalName": "ByzCorp Incorporated",
        "businessTradeName": "ByzCorp",
        "businessType": "llc",
        "companyNumber": "123456789",
        "email": "byzcorp@example.com",
        "website": "byzcorp.com",
        "logoUrl": "https://byzcorp.com/logo.png",
        "registeredAddress": {
            "streetLine1": "33 Rue La Fayette",
            "city": "Paris",
            "postalCode": "75009",
            "country": "FRA",
            "streetLine2": "WeWork",
            "state": "IDF"
        },
        "physicalAddress": {
            "streetLine1": "33 Rue La Fayette",
            "city": "Paris",
            "postalCode": "75009",
            "country": "FRA",
            "streetLine2": "WeWork",
            "state": "IDF"
        },
        "activityInfo": {
            "businessDescription": "ByzCorp does business.",
            "businessIndustry": 523110
        },
        "financialInfo": {
            "sourceOfFunds": "treasury_reserves",
            "estimatedAnnualRevenueUsd": "1000000_9999999",
            "expectedMonthlyPaymentsUsd": 5000000,
            "hasMaterialIntermediaryEntityOwner": False
        },
        "highRiskInfo": {
            "operatesInProhibitedCountries": False,
            "highRiskActivities": "none_of_the_above",
            "highRiskActivitiesExplanation": "<string>",
            "conductsMoneyServices": False,
            "conductsMoneyServicesDescription": "<string>"
        }
    },
    "entityDocuments": [
        {
            "documentType": "incorporation_cert",
            "issuingCountry": "FRA",
            "document": "data:image/png;base64,iVBORw0lFTkSuQmCC...",
            "description": "An overview of our business activities."
        }
    ]
}
headers = {
    "X-Pubkey": "<x-pubkey>",
    "X-Timestamp": "<x-timestamp>",
    "X-Signature": "<x-signature>",
    "X-Pubkey, X-Timestamp, X-Signature": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.patch(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'PATCH',
  headers: {
    'X-Pubkey': '<x-pubkey>',
    'X-Timestamp': '<x-timestamp>',
    'X-Signature': '<x-signature>',
    'X-Pubkey, X-Timestamp, X-Signature': '<api-key>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    accountId: '550e8400-e29b-41d4-a716-446655440000',
    entityInfo: {
      businessLegalName: 'ByzCorp Incorporated',
      businessTradeName: 'ByzCorp',
      businessType: 'llc',
      companyNumber: '123456789',
      email: 'byzcorp@example.com',
      website: 'byzcorp.com',
      logoUrl: 'https://byzcorp.com/logo.png',
      registeredAddress: {
        streetLine1: '33 Rue La Fayette',
        city: 'Paris',
        postalCode: '75009',
        country: 'FRA',
        streetLine2: 'WeWork',
        state: 'IDF'
      },
      physicalAddress: {
        streetLine1: '33 Rue La Fayette',
        city: 'Paris',
        postalCode: '75009',
        country: 'FRA',
        streetLine2: 'WeWork',
        state: 'IDF'
      },
      activityInfo: {businessDescription: 'ByzCorp does business.', businessIndustry: 523110},
      financialInfo: {
        sourceOfFunds: 'treasury_reserves',
        estimatedAnnualRevenueUsd: '1000000_9999999',
        expectedMonthlyPaymentsUsd: 5000000,
        hasMaterialIntermediaryEntityOwner: false
      },
      highRiskInfo: {
        operatesInProhibitedCountries: false,
        highRiskActivities: 'none_of_the_above',
        highRiskActivitiesExplanation: '<string>',
        conductsMoneyServices: false,
        conductsMoneyServicesDescription: '<string>'
      }
    },
    entityDocuments: [
      {
        documentType: 'incorporation_cert',
        issuingCountry: 'FRA',
        document: 'data:image/png;base64,iVBORw0lFTkSuQmCC...',
        description: 'An overview of our business activities.'
      }
    ]
  })
};

fetch('https://api.byzantine.fi/v1/submit/update-entity-account', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "entityId": "550e8400-e29b-41d4-a716-446655440000",
  "accountId": "550e8400-e29b-41d4-a716-446655440000",
  "verificationStatus": "active",
  "entityInfo": {
    "businessLegalName": "ByzCorp Incorporated",
    "businessTradeName": "ByzCorp",
    "businessType": "llc",
    "companyNumber": "123456789",
    "email": "byzcorp@example.com",
    "website": "byzcorp.com",
    "logoUrl": "https://byzcorp.com/logo.png",
    "registeredAddress": {
      "streetLine1": "33 Rue La Fayette",
      "city": "Paris",
      "postalCode": "75009",
      "country": "FRA",
      "streetLine2": "WeWork",
      "state": "IDF"
    },
    "physicalAddress": {
      "streetLine1": "33 Rue La Fayette",
      "city": "Paris",
      "postalCode": "75009",
      "country": "FRA",
      "streetLine2": "WeWork",
      "state": "IDF"
    },
    "activityInfo": {
      "businessDescription": "ByzCorp does business.",
      "businessIndustry": 523110
    },
    "financialInfo": {
      "preferredPrimaryCurrency": "usd",
      "sourceOfFunds": "treasury_reserves",
      "estimatedAnnualRevenueUsd": "1000000_9999999",
      "expectedMonthlyPaymentsUsd": 5000000,
      "hasMaterialIntermediaryEntityOwner": false
    },
    "highRiskInfo": {
      "operatesInProhibitedCountries": false,
      "highRiskActivities": "none_of_the_above",
      "highRiskActivitiesExplanation": "<string>",
      "conductsMoneyServices": false,
      "conductsMoneyServicesDescription": "<string>"
    }
  },
  "entityDocuments": [
    {
      "documentType": "passport",
      "issuingCountry": "FRA",
      "documentId": "830c219c-d197-451d-b879-77936a80c452",
      "documentNumber": "FR1234567890",
      "description": "Additional supporting document",
      "warnings": [
        "<string>"
      ],
      "errors": [
        "<string>"
      ]
    }
  ],
  "missingDocuments": [
    "<string>"
  ],
  "missingCompanyData": [
    "<string>"
  ]
}

Authorizations

X-Pubkey, X-Timestamp, X-Signature

string

header

required

Headers

X-Pubkey

string

required

Integrator's ECDSA public key (P-256 curve, compressed SEC1 format). Example: 0x038fedef7c12f93bbf342ad8943b7a825a3b41f61c9dc118b2c718efebabbf62fd

X-Timestamp

string

required

Unix timestamp in seconds (UTC). Must be within tolerance window (1 minute) to prevent replay attacks. Example: 1760375826

X-Signature

string

required

ECDSA signature (DER-encoded, hex with 0x prefix). Signs the message: {timestamp}{METHOD}{path_and_query}{json_body}. Example: 0x3045022100...

Body

application/json

Update entity account details

Request body for updating an entity account's company details. Only the provided fields will be updated. To add or update entity's associated persons, see the dedicated associated-persons endpoints.

accountId

string<uuid>

required

A UUID string

Example:

"550e8400-e29b-41d4-a716-446655440000"

entityInfo

object | null

Entity information for update. All fields are optional — only provided fields are updated.

Show child attributes

entityDocuments

object[] | null

Additional entity verification documents, typically the ones listed in missingDocuments of a previous response. See accepted documents.

Show child attributes

Response

Entity account updated successfully

Response body for updating an entity account

entityId

string<uuid>

required

A UUID string

Example:

"550e8400-e29b-41d4-a716-446655440000"

accountId

string<uuid>

required

A UUID string

Example:

"550e8400-e29b-41d4-a716-446655440000"

verificationStatus

enum<string>

required

The identity verification status of the user.

Available options:

not_started,

init,

under_review,

awaiting_associated_person_information,

awaiting_information,

resubmission_requested,

active,

rejected,

inactive

Example:

"active"

entityInfo

object | null

Entity information for update. All fields are optional — only provided fields are updated.

Show child attributes

entityDocuments

object[] | null

Show child attributes

missingDocuments

string[] | null

List of missing required entity verification documents. Present only if not all required documents have been submitted. Values: COMPANY_DETAILS_DOCUMENT, OWNERSHIP_STRUCTURE_DOCUMENT, SOURCE_OF_FUNDS_DOCUMENT, PROOF_OF_ADDRESS_DOCUMENT, PHYSICAL_ADDRESS_QUESTIONNAIRE, ACTIVITY_INFO_QUESTIONNAIRE, FINANCIAL_INFO_QUESTIONNAIRE.

missingCompanyData

string[] | null

List of missing required company data. Present only if not all required company information has been provided.

Integrator API

API endpoints

Update an entity account's company details

Authorizations

Headers

Body

Response