curl --request POST \
--url https://api.byzantine.fi/v1/submit/create-entity \
--header 'Content-Type: application/json' \
--header 'X-Pubkey: <api-key>' \
--header 'X-Signature: <x-signature>' \
--header 'X-Timestamp: <x-timestamp>' \
--data '
{
"entityInfo": {
"businessLegalName": "ByzCorp Incorporated",
"businessTradeName": "ByzCorp",
"businessDescription": "ByzCorp does business.",
"businessType": "LLC",
"email": "[email protected]",
"website": "byzcorp.com",
"businessIndustry": "byzcorp.com",
"companyNumber": "byzcorp.com",
"hasMaterialIntermediaryEntityOwner": "false",
"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"
},
"businessActivityInfo": {
"preferredPrimaryCurrency": "usd",
"sourceOfFunds": "treasury_reserves",
"estimatedAnnualRevenueUsd": "1000000_9999999",
"expectedMonthlyPaymentsUsd": "5000000",
"operatesInProhibitedCountries": "false",
"highRiskActivities": "none_of_the_above",
"highRiskActivitiesExplanation": "As a jewelry shop, we deal with precious stones.",
"conductsMoneyServices": "false",
"conductsMoneyServicesDescription": "We operate several ATMs."
}
},
"associatedPersons": [
{
"isOrgAdmin": "true",
"userInfo": {
"firstName": "John",
"lastName": "Smith",
"email": "[email protected]",
"birthDate": "1990-01-01",
"nationality": "FRA",
"residentialAddress": {
"streetLine1": "33 Rue La Fayette",
"city": "Paris",
"postalCode": "75009",
"country": "FRA",
"streetLine2": "WeWork",
"state": "IDF"
},
"middleName": "William",
"phone": "+33 123 456 789",
"socialSecurityNumber": "123-45-6789"
},
"beneficiaryDetails": {
"beneficiaryType": [
"UBO"
],
"title": "CEO",
"ownershipPercentage": "32.5"
},
"verificationDocuments": [
{
"documentType": "passport",
"issuingCountry": "FRA",
"document": "data:image/png;base64,iVBORw0lFTkSuQmCC...",
"documentNumber": "FR1234567890",
"description": "Additional supporting document"
}
],
"authenticators": [
{
"authenticatorName": "<string>",
"challenge": "<string>",
"attestation": {
"credentialId": "<string>",
"clientDataJson": "<string>",
"attestationObject": "<string>",
"transports": [
"<string>"
]
}
}
]
}
],
"requiredApprovals": 1,
"bridgeSignedAgreementId": "d107c1e1-766a-4091-802c-de61a3973e91",
"byzantineTermsSignedAt": "2025-11-19T21:14:58.328Z",
"entityDocuments": [
{
"documentType": "business_formation",
"issuingCountry": "FRA",
"document": "data:image/png;base64,iVBORw0lFTkSuQmCC...",
"description": "An overview of our business activities."
}
]
}
'{
"entityId": "550e8400-e29b-41d4-a716-446655440000",
"accountId": "550e8400-e29b-41d4-a716-446655440000",
"verificationStatus": "active",
"entityInfo": {
"businessLegalName": "ByzCorp Incorporated",
"businessTradeName": "ByzCorp",
"businessDescription": "ByzCorp does business.",
"businessType": "LLC",
"email": "[email protected]",
"website": "byzcorp.com",
"businessIndustry": "byzcorp.com",
"companyNumber": "byzcorp.com",
"hasMaterialIntermediaryEntityOwner": "false",
"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"
},
"businessActivityInfo": {
"preferredPrimaryCurrency": "usd",
"sourceOfFunds": "treasury_reserves",
"estimatedAnnualRevenueUsd": "1000000_9999999",
"expectedMonthlyPaymentsUsd": "5000000",
"operatesInProhibitedCountries": "false",
"highRiskActivities": "none_of_the_above",
"highRiskActivitiesExplanation": "As a jewelry shop, we deal with precious stones.",
"conductsMoneyServices": "false",
"conductsMoneyServicesDescription": "We operate several ATMs."
}
},
"associatedPersons": [
{
"userId": "550e8400-e29b-41d4-a716-446655440000",
"verificationStatus": "active",
"isOrgAdmin": "true",
"userInfo": {
"firstName": "John",
"lastName": "Smith",
"email": "[email protected]",
"birthDate": "1990-01-01",
"nationality": "FRA",
"residentialAddress": {
"streetLine1": "33 Rue La Fayette",
"city": "Paris",
"postalCode": "75009",
"country": "FRA",
"streetLine2": "WeWork",
"state": "IDF"
},
"middleName": "William",
"phone": "+33 123 456 789",
"socialSecurityNumber": "123-45-6789"
},
"beneficiaryDetails": {
"beneficiaryType": [
"UBO"
],
"title": "CEO",
"ownershipPercentage": "32.5"
},
"verificationDocuments": [
{
"documentType": "passport",
"issuingCountry": "FRA",
"documentId": "830c219c-d197-451d-b879-77936a80c452",
"documentNumber": "FR1234567890",
"description": "Additional supporting document",
"warnings": [
"<string>"
],
"errors": [
"<string>"
]
}
],
"isPasskeyActivated": "false",
"isOtpActivated": "true"
}
],
"requiredApprovals": 1,
"bridgeSignedAgreementId": "d107c1e1-766a-4091-802c-de61a3973e91",
"byzantineTermsSignedAt": "2025-11-19T21:14:58.328Z",
"entityDocuments": [
{
"documentType": "passport",
"issuingCountry": "FRA",
"documentId": "830c219c-d197-451d-b879-77936a80c452",
"documentNumber": "FR1234567890",
"description": "Additional supporting document",
"warnings": [
"<string>"
],
"errors": [
"<string>"
]
}
]
}Create a Byzantine entity
curl --request POST \
--url https://api.byzantine.fi/v1/submit/create-entity \
--header 'Content-Type: application/json' \
--header 'X-Pubkey: <api-key>' \
--header 'X-Signature: <x-signature>' \
--header 'X-Timestamp: <x-timestamp>' \
--data '
{
"entityInfo": {
"businessLegalName": "ByzCorp Incorporated",
"businessTradeName": "ByzCorp",
"businessDescription": "ByzCorp does business.",
"businessType": "LLC",
"email": "[email protected]",
"website": "byzcorp.com",
"businessIndustry": "byzcorp.com",
"companyNumber": "byzcorp.com",
"hasMaterialIntermediaryEntityOwner": "false",
"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"
},
"businessActivityInfo": {
"preferredPrimaryCurrency": "usd",
"sourceOfFunds": "treasury_reserves",
"estimatedAnnualRevenueUsd": "1000000_9999999",
"expectedMonthlyPaymentsUsd": "5000000",
"operatesInProhibitedCountries": "false",
"highRiskActivities": "none_of_the_above",
"highRiskActivitiesExplanation": "As a jewelry shop, we deal with precious stones.",
"conductsMoneyServices": "false",
"conductsMoneyServicesDescription": "We operate several ATMs."
}
},
"associatedPersons": [
{
"isOrgAdmin": "true",
"userInfo": {
"firstName": "John",
"lastName": "Smith",
"email": "[email protected]",
"birthDate": "1990-01-01",
"nationality": "FRA",
"residentialAddress": {
"streetLine1": "33 Rue La Fayette",
"city": "Paris",
"postalCode": "75009",
"country": "FRA",
"streetLine2": "WeWork",
"state": "IDF"
},
"middleName": "William",
"phone": "+33 123 456 789",
"socialSecurityNumber": "123-45-6789"
},
"beneficiaryDetails": {
"beneficiaryType": [
"UBO"
],
"title": "CEO",
"ownershipPercentage": "32.5"
},
"verificationDocuments": [
{
"documentType": "passport",
"issuingCountry": "FRA",
"document": "data:image/png;base64,iVBORw0lFTkSuQmCC...",
"documentNumber": "FR1234567890",
"description": "Additional supporting document"
}
],
"authenticators": [
{
"authenticatorName": "<string>",
"challenge": "<string>",
"attestation": {
"credentialId": "<string>",
"clientDataJson": "<string>",
"attestationObject": "<string>",
"transports": [
"<string>"
]
}
}
]
}
],
"requiredApprovals": 1,
"bridgeSignedAgreementId": "d107c1e1-766a-4091-802c-de61a3973e91",
"byzantineTermsSignedAt": "2025-11-19T21:14:58.328Z",
"entityDocuments": [
{
"documentType": "business_formation",
"issuingCountry": "FRA",
"document": "data:image/png;base64,iVBORw0lFTkSuQmCC...",
"description": "An overview of our business activities."
}
]
}
'{
"entityId": "550e8400-e29b-41d4-a716-446655440000",
"accountId": "550e8400-e29b-41d4-a716-446655440000",
"verificationStatus": "active",
"entityInfo": {
"businessLegalName": "ByzCorp Incorporated",
"businessTradeName": "ByzCorp",
"businessDescription": "ByzCorp does business.",
"businessType": "LLC",
"email": "[email protected]",
"website": "byzcorp.com",
"businessIndustry": "byzcorp.com",
"companyNumber": "byzcorp.com",
"hasMaterialIntermediaryEntityOwner": "false",
"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"
},
"businessActivityInfo": {
"preferredPrimaryCurrency": "usd",
"sourceOfFunds": "treasury_reserves",
"estimatedAnnualRevenueUsd": "1000000_9999999",
"expectedMonthlyPaymentsUsd": "5000000",
"operatesInProhibitedCountries": "false",
"highRiskActivities": "none_of_the_above",
"highRiskActivitiesExplanation": "As a jewelry shop, we deal with precious stones.",
"conductsMoneyServices": "false",
"conductsMoneyServicesDescription": "We operate several ATMs."
}
},
"associatedPersons": [
{
"userId": "550e8400-e29b-41d4-a716-446655440000",
"verificationStatus": "active",
"isOrgAdmin": "true",
"userInfo": {
"firstName": "John",
"lastName": "Smith",
"email": "[email protected]",
"birthDate": "1990-01-01",
"nationality": "FRA",
"residentialAddress": {
"streetLine1": "33 Rue La Fayette",
"city": "Paris",
"postalCode": "75009",
"country": "FRA",
"streetLine2": "WeWork",
"state": "IDF"
},
"middleName": "William",
"phone": "+33 123 456 789",
"socialSecurityNumber": "123-45-6789"
},
"beneficiaryDetails": {
"beneficiaryType": [
"UBO"
],
"title": "CEO",
"ownershipPercentage": "32.5"
},
"verificationDocuments": [
{
"documentType": "passport",
"issuingCountry": "FRA",
"documentId": "830c219c-d197-451d-b879-77936a80c452",
"documentNumber": "FR1234567890",
"description": "Additional supporting document",
"warnings": [
"<string>"
],
"errors": [
"<string>"
]
}
],
"isPasskeyActivated": "false",
"isOtpActivated": "true"
}
],
"requiredApprovals": 1,
"bridgeSignedAgreementId": "d107c1e1-766a-4091-802c-de61a3973e91",
"byzantineTermsSignedAt": "2025-11-19T21:14:58.328Z",
"entityDocuments": [
{
"documentType": "passport",
"issuingCountry": "FRA",
"documentId": "830c219c-d197-451d-b879-77936a80c452",
"documentNumber": "FR1234567890",
"description": "Additional supporting document",
"warnings": [
"<string>"
],
"errors": [
"<string>"
]
}
]
}Authorizations
Integrator's ECDSA public key (P-256 curve, compressed SEC1 format). Example: 0x038fedef7c12f93bbf342ad8943b7a825a3b41f61c9dc118b2c718efebabbf62fd
Headers
Unix timestamp in seconds (UTC). Must be within tolerance window (1 minute) to prevent replay attacks. Example: 1760375826
ECDSA signature (DER-encoded, hex with 0x prefix). Signs the message: {timestamp}{METHOD}{path_and_query}{json_body}. Example: 0x3045022100...
Body
Entity to be created. The vast majority of fields are required in order to complete the identity verification process.
Entity information for KYB
Show child attributes
Show child attributes
The legal name of the business.
"ByzCorp Incorporated"
The trade name of the business. Can be the same as the entity name, but must be submitted.
"ByzCorp"
Short description of business activities.
1 - 1024"ByzCorp does business."
Business legal form. Select that most appropriate one fitting your jurisdiction.
cooperative, corporation, llc, other, partnership, sole_prop, trust "LLC"
Business contact email.
Business website.
"byzcorp.com"
A valid 6-digit NAICS industry code. See the full list of industry codes.
x >= 0"byzcorp.com"
The registered business number. Depending on the country of registration, we accept these entity number types.
"byzcorp.com"
true if there is another legal entity that owns 25% or more of the business
"false"
Address information. Must be a valid address in the relevant country.
Show child attributes
Show child attributes
"33 Rue La Fayette"
"Paris"
Postal code.
"75009"
The ISO 3166-1 (three-character) country code of the relevant country. See the full list of countries.
ABW, AFG, AGO, ALB, AND, ARG, ARM, AUS, AUT, AZE, BEL, BGD, BGR, BHR, BHS, BIH, BLZ, BMU, BOL, BRA, BRB, BWA, CAN, CHL, CHN, CIV, CMR, COL, COM, CRI, CUW, CXR, CYM, CYP, CZE, DEU, DMA, DNK, DOM, DZA, ECU, EGY, ESP, EST, ETH, FIN, FJI, FRA, GBR, GEO, GHA, GIB, GRC, GTM, HKG, HND, HRV, HTI, HUN, IDN, IMN, IND, IRL, IRQ, ISL, ISR, ITA, JAM, JOR, JPN, KAZ, KEN, KGZ, KHM, KNA, KOR, KWT, LAO, LBN, LBR, LCA, LKA, LTU, LUX, LVA, MAR, MCO, MDA, MDG, MEX, MHL, MKD, MLT, MNE, MOZ, MRT, MUS, MWI, MYS, NAM, NGA, NIC, NLD, NOR, NPL, NZL, OMN, PAN, PER, PHL, PAK, POL, PRT, QAT, ROU, RUS, SAU, SEN, SGP, SVK, SVN, ZAF, SWE, CHE, THA, TUN, TUR, UGA, UKR, ARE, USA, URY, UZB, VEN, VNM, YEM, ZMB, ZWE "FRA"
Optional additional details to the street name and number.
"WeWork"
Required for US addresses. Should be a valid ISO 3166-2 subdivision code.
"IDF"
Address information. Must be a valid address in the relevant country.
Show child attributes
Show child attributes
"33 Rue La Fayette"
"Paris"
Postal code.
"75009"
The ISO 3166-1 (three-character) country code of the relevant country. See the full list of countries.
ABW, AFG, AGO, ALB, AND, ARG, ARM, AUS, AUT, AZE, BEL, BGD, BGR, BHR, BHS, BIH, BLZ, BMU, BOL, BRA, BRB, BWA, CAN, CHL, CHN, CIV, CMR, COL, COM, CRI, CUW, CXR, CYM, CYP, CZE, DEU, DMA, DNK, DOM, DZA, ECU, EGY, ESP, EST, ETH, FIN, FJI, FRA, GBR, GEO, GHA, GIB, GRC, GTM, HKG, HND, HRV, HTI, HUN, IDN, IMN, IND, IRL, IRQ, ISL, ISR, ITA, JAM, JOR, JPN, KAZ, KEN, KGZ, KHM, KNA, KOR, KWT, LAO, LBN, LBR, LCA, LKA, LTU, LUX, LVA, MAR, MCO, MDA, MDG, MEX, MHL, MKD, MLT, MNE, MOZ, MRT, MUS, MWI, MYS, NAM, NGA, NIC, NLD, NOR, NPL, NZL, OMN, PAN, PER, PHL, PAK, POL, PRT, QAT, ROU, RUS, SAU, SEN, SGP, SVK, SVN, ZAF, SWE, CHE, THA, TUN, TUR, UGA, UKR, ARE, USA, URY, UZB, VEN, VNM, YEM, ZMB, ZWE "FRA"
Optional additional details to the street name and number.
"WeWork"
Required for US addresses. Should be a valid ISO 3166-2 subdivision code.
"IDF"
Information about business activities. This is required for high-risk businesses. Filling it wholly can accelerate the KYB process.
Show child attributes
Show child attributes
usd, eur, usdc, eurc Source of funds for entities.
business_loans, grants, inter_company_funds, investment_proceeds, legal_settlement, owners_capital, pension_retirement, sale_of_assets, sales_of_goods_and_services, tax_refund, third_party_funds, treasury_reserves "treasury_reserves"
Estimated annual business revenue in USD, defined as a range.
0_99999, 100000_999999, 1000000_9999999, 10000000_49999999, 50000000_249999999, 250000000_plus "1000000_9999999"
Expected monthly inflows in USD.
"5000000"
Must be set to true if the business has any activity in or relation to Cuba, Iran, Myanmar, North Korea, or Syria.
"false"
High risk business activities. Must be declared if the business is engaged in any.
adult_entertainment, gambling, hold_client_funds, investment_services, lending_banking, marijuana_or_related_services, money_services, nicotine_tobacco_or_related_services, operate_foreign_exchange_virtual_currencies_brokerage_otc, pharmaceuticals, precious_metals_precious_stones_jewelry, safe_deposit_box_rentals, third_party_payment_processing, weapons_firearms_and_explosives, none_of_the_above "none_of_the_above"
Required if high_risk_activities is anything other than none_of_the_above or empty. A short description to explain the business' involvement with the declared high-risk activities.
"As a jewelry shop, we deal with precious stones."
Must be set to true if the business offers money services, investment products, and/or other financial services.
"false"
Required if conducts_money_services is true. A short description to explain the business' money services. Should include a detailed description of the business's compliance and anti-money laundering controls and practices.
"We operate several ATMs."
Show child attributes
Show child attributes
Set to true if this person should be an active controller of the account. At least one org_admin is required.
"true"
Personal information about the user required for identity verification.
Show child attributes
Show child attributes
First name of the user.
"John"
Last name of the user.
"Smith"
Contact email of the user.
User's date of birth.
"1990-01-01"
The ISO 3166-1 (three-character) country code of the relevant country. See the full list of countries.
ABW, AFG, AGO, ALB, AND, ARG, ARM, AUS, AUT, AZE, BEL, BGD, BGR, BHR, BHS, BIH, BLZ, BMU, BOL, BRA, BRB, BWA, CAN, CHL, CHN, CIV, CMR, COL, COM, CRI, CUW, CXR, CYM, CYP, CZE, DEU, DMA, DNK, DOM, DZA, ECU, EGY, ESP, EST, ETH, FIN, FJI, FRA, GBR, GEO, GHA, GIB, GRC, GTM, HKG, HND, HRV, HTI, HUN, IDN, IMN, IND, IRL, IRQ, ISL, ISR, ITA, JAM, JOR, JPN, KAZ, KEN, KGZ, KHM, KNA, KOR, KWT, LAO, LBN, LBR, LCA, LKA, LTU, LUX, LVA, MAR, MCO, MDA, MDG, MEX, MHL, MKD, MLT, MNE, MOZ, MRT, MUS, MWI, MYS, NAM, NGA, NIC, NLD, NOR, NPL, NZL, OMN, PAN, PER, PHL, PAK, POL, PRT, QAT, ROU, RUS, SAU, SEN, SGP, SVK, SVN, ZAF, SWE, CHE, THA, TUN, TUR, UGA, UKR, ARE, USA, URY, UZB, VEN, VNM, YEM, ZMB, ZWE "FRA"
Address information. Must be a valid address in the relevant country.
Show child attributes
Show child attributes
"33 Rue La Fayette"
"Paris"
Postal code.
"75009"
The ISO 3166-1 (three-character) country code of the relevant country. See the full list of countries.
ABW, AFG, AGO, ALB, AND, ARG, ARM, AUS, AUT, AZE, BEL, BGD, BGR, BHR, BHS, BIH, BLZ, BMU, BOL, BRA, BRB, BWA, CAN, CHL, CHN, CIV, CMR, COL, COM, CRI, CUW, CXR, CYM, CYP, CZE, DEU, DMA, DNK, DOM, DZA, ECU, EGY, ESP, EST, ETH, FIN, FJI, FRA, GBR, GEO, GHA, GIB, GRC, GTM, HKG, HND, HRV, HTI, HUN, IDN, IMN, IND, IRL, IRQ, ISL, ISR, ITA, JAM, JOR, JPN, KAZ, KEN, KGZ, KHM, KNA, KOR, KWT, LAO, LBN, LBR, LCA, LKA, LTU, LUX, LVA, MAR, MCO, MDA, MDG, MEX, MHL, MKD, MLT, MNE, MOZ, MRT, MUS, MWI, MYS, NAM, NGA, NIC, NLD, NOR, NPL, NZL, OMN, PAN, PER, PHL, PAK, POL, PRT, QAT, ROU, RUS, SAU, SEN, SGP, SVK, SVN, ZAF, SWE, CHE, THA, TUN, TUR, UGA, UKR, ARE, USA, URY, UZB, VEN, VNM, YEM, ZMB, ZWE "FRA"
Optional additional details to the street name and number.
"WeWork"
Required for US addresses. Should be a valid ISO 3166-2 subdivision code.
"IDF"
Middle name of the user.
"William"
Phone number of the user.
"+33 123 456 789"
Required exclusively for USA-based users. Must be the full social security number.
"123-45-6789"
Additional details about beneficiaries.
Show child attributes
Show child attributes
Beneficiary type.
UBOs are any individuals who, directly or inderectly, own more than 25% of the business.
Representatives are individuals who have direct control over daily operations.
ubo, representative Required for representatives. The title held at the business.
"CEO"
Required for UBOs. The % of direct or indirect business ownership.
"32.5"
Show child attributes
Show child attributes
Type of the document. See the full list of accepted documents.
passport, national_id_front, national_id_back, proof_of_address, other The ISO 3166-1 (three-character) country code of the relevant country. See the full list of countries.
ABW, AFG, AGO, ALB, AND, ARG, ARM, AUS, AUT, AZE, BEL, BGD, BGR, BHR, BHS, BIH, BLZ, BMU, BOL, BRA, BRB, BWA, CAN, CHL, CHN, CIV, CMR, COL, COM, CRI, CUW, CXR, CYM, CYP, CZE, DEU, DMA, DNK, DOM, DZA, ECU, EGY, ESP, EST, ETH, FIN, FJI, FRA, GBR, GEO, GHA, GIB, GRC, GTM, HKG, HND, HRV, HTI, HUN, IDN, IMN, IND, IRL, IRQ, ISL, ISR, ITA, JAM, JOR, JPN, KAZ, KEN, KGZ, KHM, KNA, KOR, KWT, LAO, LBN, LBR, LCA, LKA, LTU, LUX, LVA, MAR, MCO, MDA, MDG, MEX, MHL, MKD, MLT, MNE, MOZ, MRT, MUS, MWI, MYS, NAM, NGA, NIC, NLD, NOR, NPL, NZL, OMN, PAN, PER, PHL, PAK, POL, PRT, QAT, ROU, RUS, SAU, SEN, SGP, SVK, SVN, ZAF, SWE, CHE, THA, TUN, TUR, UGA, UKR, ARE, USA, URY, UZB, VEN, VNM, YEM, ZMB, ZWE "FRA"
The document to be uploaded.
Supported MIME types: image/jpeg, image/png, image/heic, image/tiff, application/pdf
"data:image/png;base64,iVBORw0lFTkSuQmCC..."
Required for identity documents (passport, national ID). Must be the full document number.
"FR1234567890"
Required if document type is 'other'.
"Additional supporting document"
Show child attributes
Show child attributes
Human-readable name for an Authenticator.
Challenge presented for authentication purposes.
Show child attributes
Show child attributes
The cbor encoded then base64 url encoded id of the credential.
A base64 url encoded payload containing metadata about the signing context and the challenge.
A base64 url encoded payload containing authenticator data and any attestation the webauthn provider chooses.
Deprecated
x >= 0The ID of the signed Bridge ToS agreement. For more information, see individual account creation - KYC.
"d107c1e1-766a-4091-802c-de61a3973e91"
The timestamp when the Byzantine Finance Terms & Conditions were signed. For more information, see individual account creation - KYC.
"2025-11-19T21:14:58.328Z"
Show child attributes
Show child attributes
Entity document type. For a full list of accepted document types, see accepted documents.
aml_comfort_letter, business_formation, directors_registry, e_signature_certificate, evidence_of_good_standing, flow_of_funds, marketing_materials, ownership_chart, ownership_information, proof_of_account_purpose, proof_of_address, proof_of_entity_name_change, proof_of_nature_of_business, proof_of_signatory_authority, proof_of_source_of_funds, proof_of_source_of_wealth, proof_of_tax_identification, shareholder_register, other "business_formation"
The ISO 3166-1 (three-character) country code of the relevant country. See the full list of countries.
ABW, AFG, AGO, ALB, AND, ARG, ARM, AUS, AUT, AZE, BEL, BGD, BGR, BHR, BHS, BIH, BLZ, BMU, BOL, BRA, BRB, BWA, CAN, CHL, CHN, CIV, CMR, COL, COM, CRI, CUW, CXR, CYM, CYP, CZE, DEU, DMA, DNK, DOM, DZA, ECU, EGY, ESP, EST, ETH, FIN, FJI, FRA, GBR, GEO, GHA, GIB, GRC, GTM, HKG, HND, HRV, HTI, HUN, IDN, IMN, IND, IRL, IRQ, ISL, ISR, ITA, JAM, JOR, JPN, KAZ, KEN, KGZ, KHM, KNA, KOR, KWT, LAO, LBN, LBR, LCA, LKA, LTU, LUX, LVA, MAR, MCO, MDA, MDG, MEX, MHL, MKD, MLT, MNE, MOZ, MRT, MUS, MWI, MYS, NAM, NGA, NIC, NLD, NOR, NPL, NZL, OMN, PAN, PER, PHL, PAK, POL, PRT, QAT, ROU, RUS, SAU, SEN, SGP, SVK, SVN, ZAF, SWE, CHE, THA, TUN, TUR, UGA, UKR, ARE, USA, URY, UZB, VEN, VNM, YEM, ZMB, ZWE "FRA"
The document to be uploaded.
Supported MIME types: image/jpeg, image/png, image/heic, image/tiff, application/pdf
"data:image/png;base64,iVBORw0lFTkSuQmCC..."
A description of the document. Must be submitted if document if os type other.
"An overview of our business activities."
Response
Entity created successfully
Response body for creating a Byzantine entity
A UUID string
"550e8400-e29b-41d4-a716-446655440000"
A UUID string
"550e8400-e29b-41d4-a716-446655440000"
The identity verification status of the user.
under_review, waiting_for_information, active, rejected, inactive "active"
Entity information for KYB
Show child attributes
Show child attributes
The legal name of the business.
"ByzCorp Incorporated"
The trade name of the business. Can be the same as the entity name, but must be submitted.
"ByzCorp"
Short description of business activities.
1 - 1024"ByzCorp does business."
Business legal form. Select that most appropriate one fitting your jurisdiction.
cooperative, corporation, llc, other, partnership, sole_prop, trust "LLC"
Business contact email.
Business website.
"byzcorp.com"
A valid 6-digit NAICS industry code. See the full list of industry codes.
x >= 0"byzcorp.com"
The registered business number. Depending on the country of registration, we accept these entity number types.
"byzcorp.com"
true if there is another legal entity that owns 25% or more of the business
"false"
Address information. Must be a valid address in the relevant country.
Show child attributes
Show child attributes
"33 Rue La Fayette"
"Paris"
Postal code.
"75009"
The ISO 3166-1 (three-character) country code of the relevant country. See the full list of countries.
ABW, AFG, AGO, ALB, AND, ARG, ARM, AUS, AUT, AZE, BEL, BGD, BGR, BHR, BHS, BIH, BLZ, BMU, BOL, BRA, BRB, BWA, CAN, CHL, CHN, CIV, CMR, COL, COM, CRI, CUW, CXR, CYM, CYP, CZE, DEU, DMA, DNK, DOM, DZA, ECU, EGY, ESP, EST, ETH, FIN, FJI, FRA, GBR, GEO, GHA, GIB, GRC, GTM, HKG, HND, HRV, HTI, HUN, IDN, IMN, IND, IRL, IRQ, ISL, ISR, ITA, JAM, JOR, JPN, KAZ, KEN, KGZ, KHM, KNA, KOR, KWT, LAO, LBN, LBR, LCA, LKA, LTU, LUX, LVA, MAR, MCO, MDA, MDG, MEX, MHL, MKD, MLT, MNE, MOZ, MRT, MUS, MWI, MYS, NAM, NGA, NIC, NLD, NOR, NPL, NZL, OMN, PAN, PER, PHL, PAK, POL, PRT, QAT, ROU, RUS, SAU, SEN, SGP, SVK, SVN, ZAF, SWE, CHE, THA, TUN, TUR, UGA, UKR, ARE, USA, URY, UZB, VEN, VNM, YEM, ZMB, ZWE "FRA"
Optional additional details to the street name and number.
"WeWork"
Required for US addresses. Should be a valid ISO 3166-2 subdivision code.
"IDF"
Address information. Must be a valid address in the relevant country.
Show child attributes
Show child attributes
"33 Rue La Fayette"
"Paris"
Postal code.
"75009"
The ISO 3166-1 (three-character) country code of the relevant country. See the full list of countries.
ABW, AFG, AGO, ALB, AND, ARG, ARM, AUS, AUT, AZE, BEL, BGD, BGR, BHR, BHS, BIH, BLZ, BMU, BOL, BRA, BRB, BWA, CAN, CHL, CHN, CIV, CMR, COL, COM, CRI, CUW, CXR, CYM, CYP, CZE, DEU, DMA, DNK, DOM, DZA, ECU, EGY, ESP, EST, ETH, FIN, FJI, FRA, GBR, GEO, GHA, GIB, GRC, GTM, HKG, HND, HRV, HTI, HUN, IDN, IMN, IND, IRL, IRQ, ISL, ISR, ITA, JAM, JOR, JPN, KAZ, KEN, KGZ, KHM, KNA, KOR, KWT, LAO, LBN, LBR, LCA, LKA, LTU, LUX, LVA, MAR, MCO, MDA, MDG, MEX, MHL, MKD, MLT, MNE, MOZ, MRT, MUS, MWI, MYS, NAM, NGA, NIC, NLD, NOR, NPL, NZL, OMN, PAN, PER, PHL, PAK, POL, PRT, QAT, ROU, RUS, SAU, SEN, SGP, SVK, SVN, ZAF, SWE, CHE, THA, TUN, TUR, UGA, UKR, ARE, USA, URY, UZB, VEN, VNM, YEM, ZMB, ZWE "FRA"
Optional additional details to the street name and number.
"WeWork"
Required for US addresses. Should be a valid ISO 3166-2 subdivision code.
"IDF"
Information about business activities. This is required for high-risk businesses. Filling it wholly can accelerate the KYB process.
Show child attributes
Show child attributes
usd, eur, usdc, eurc Source of funds for entities.
business_loans, grants, inter_company_funds, investment_proceeds, legal_settlement, owners_capital, pension_retirement, sale_of_assets, sales_of_goods_and_services, tax_refund, third_party_funds, treasury_reserves "treasury_reserves"
Estimated annual business revenue in USD, defined as a range.
0_99999, 100000_999999, 1000000_9999999, 10000000_49999999, 50000000_249999999, 250000000_plus "1000000_9999999"
Expected monthly inflows in USD.
"5000000"
Must be set to true if the business has any activity in or relation to Cuba, Iran, Myanmar, North Korea, or Syria.
"false"
High risk business activities. Must be declared if the business is engaged in any.
adult_entertainment, gambling, hold_client_funds, investment_services, lending_banking, marijuana_or_related_services, money_services, nicotine_tobacco_or_related_services, operate_foreign_exchange_virtual_currencies_brokerage_otc, pharmaceuticals, precious_metals_precious_stones_jewelry, safe_deposit_box_rentals, third_party_payment_processing, weapons_firearms_and_explosives, none_of_the_above "none_of_the_above"
Required if high_risk_activities is anything other than none_of_the_above or empty. A short description to explain the business' involvement with the declared high-risk activities.
"As a jewelry shop, we deal with precious stones."
Must be set to true if the business offers money services, investment products, and/or other financial services.
"false"
Required if conducts_money_services is true. A short description to explain the business' money services. Should include a detailed description of the business's compliance and anti-money laundering controls and practices.
"We operate several ATMs."
Show child attributes
Show child attributes
A UUID string
"550e8400-e29b-41d4-a716-446655440000"
The identity verification status of the user.
under_review, waiting_for_information, active, rejected, inactive "active"
Set to true if this person should be an active controller of the account. At least one org_admin is required.
"true"
Personal information about the user required for identity verification.
Show child attributes
Show child attributes
First name of the user.
"John"
Last name of the user.
"Smith"
Contact email of the user.
User's date of birth.
"1990-01-01"
The ISO 3166-1 (three-character) country code of the relevant country. See the full list of countries.
ABW, AFG, AGO, ALB, AND, ARG, ARM, AUS, AUT, AZE, BEL, BGD, BGR, BHR, BHS, BIH, BLZ, BMU, BOL, BRA, BRB, BWA, CAN, CHL, CHN, CIV, CMR, COL, COM, CRI, CUW, CXR, CYM, CYP, CZE, DEU, DMA, DNK, DOM, DZA, ECU, EGY, ESP, EST, ETH, FIN, FJI, FRA, GBR, GEO, GHA, GIB, GRC, GTM, HKG, HND, HRV, HTI, HUN, IDN, IMN, IND, IRL, IRQ, ISL, ISR, ITA, JAM, JOR, JPN, KAZ, KEN, KGZ, KHM, KNA, KOR, KWT, LAO, LBN, LBR, LCA, LKA, LTU, LUX, LVA, MAR, MCO, MDA, MDG, MEX, MHL, MKD, MLT, MNE, MOZ, MRT, MUS, MWI, MYS, NAM, NGA, NIC, NLD, NOR, NPL, NZL, OMN, PAN, PER, PHL, PAK, POL, PRT, QAT, ROU, RUS, SAU, SEN, SGP, SVK, SVN, ZAF, SWE, CHE, THA, TUN, TUR, UGA, UKR, ARE, USA, URY, UZB, VEN, VNM, YEM, ZMB, ZWE "FRA"
Address information. Must be a valid address in the relevant country.
Show child attributes
Show child attributes
"33 Rue La Fayette"
"Paris"
Postal code.
"75009"
The ISO 3166-1 (three-character) country code of the relevant country. See the full list of countries.
ABW, AFG, AGO, ALB, AND, ARG, ARM, AUS, AUT, AZE, BEL, BGD, BGR, BHR, BHS, BIH, BLZ, BMU, BOL, BRA, BRB, BWA, CAN, CHL, CHN, CIV, CMR, COL, COM, CRI, CUW, CXR, CYM, CYP, CZE, DEU, DMA, DNK, DOM, DZA, ECU, EGY, ESP, EST, ETH, FIN, FJI, FRA, GBR, GEO, GHA, GIB, GRC, GTM, HKG, HND, HRV, HTI, HUN, IDN, IMN, IND, IRL, IRQ, ISL, ISR, ITA, JAM, JOR, JPN, KAZ, KEN, KGZ, KHM, KNA, KOR, KWT, LAO, LBN, LBR, LCA, LKA, LTU, LUX, LVA, MAR, MCO, MDA, MDG, MEX, MHL, MKD, MLT, MNE, MOZ, MRT, MUS, MWI, MYS, NAM, NGA, NIC, NLD, NOR, NPL, NZL, OMN, PAN, PER, PHL, PAK, POL, PRT, QAT, ROU, RUS, SAU, SEN, SGP, SVK, SVN, ZAF, SWE, CHE, THA, TUN, TUR, UGA, UKR, ARE, USA, URY, UZB, VEN, VNM, YEM, ZMB, ZWE "FRA"
Optional additional details to the street name and number.
"WeWork"
Required for US addresses. Should be a valid ISO 3166-2 subdivision code.
"IDF"
Middle name of the user.
"William"
Phone number of the user.
"+33 123 456 789"
Required exclusively for USA-based users. Must be the full social security number.
"123-45-6789"
Additional details about beneficiaries.
Show child attributes
Show child attributes
Beneficiary type.
UBOs are any individuals who, directly or inderectly, own more than 25% of the business.
Representatives are individuals who have direct control over daily operations.
ubo, representative Required for representatives. The title held at the business.
"CEO"
Required for UBOs. The % of direct or indirect business ownership.
"32.5"
Show child attributes
Show child attributes
Type of verification document.
passport, national_id_front, national_id_back, proof_of_address, other Unique identifier assigned to the document.
"830c219c-d197-451d-b879-77936a80c452"
The full document number sent with the document.
"FR1234567890"
"Additional supporting document"
An indicator showing whether passkey authentication is active for this user. For more information, see wallet authentication.
"false"
An indicator showing whether OTP authentication is active for this user. For more information, see wallet authentication.
"true"
x >= 0The ID of the signed Bridge ToS agreement. For more information, see individual account creation - KYC.
"d107c1e1-766a-4091-802c-de61a3973e91"
The timestamp when the Byzantine Finance Terms & Conditions were signed. For more information, see individual account creation - KYC.
"2025-11-19T21:14:58.328Z"
Show child attributes
Show child attributes
Type of verification document.
passport, national_id_front, national_id_back, proof_of_address, other Unique identifier assigned to the document.
"830c219c-d197-451d-b879-77936a80c452"
The full document number sent with the document.
"FR1234567890"
"Additional supporting document"