latestOpenAPI 3.1.02026-07-241653251.3 MB
8b647d934363
Entity Participants
Create entity customer
Submits an entity customer to be affiliated with your platform. Your platform will need to be configured properly before you can use this endpoint.
post/participants/entity/new
Headers
X-SCX-SIGNEDstring required
HMAC-SHA256 signature of the request, base64-encoded. See the Authentication guide for the exact signing formula.
X-SCX-TIMESTAMPstring required
Example:1678901234
Current Unix timestamp in seconds. Must be within 60 seconds of server time or the request is rejected.
Request body
Example request
{
"platform_code": "PLAT01",
"entity_name": "Entity Name",
"legal_name": "Legal Name",
"contact_number": "15557778888",
"website": "company.com",
"date_established": "1985-09-02",
"entity_type": "corporation",
"address_one": "123 Main St.",
"address_two": "Suite 1000",
"city": "Chicago",
"postal_code": "12345",
"tax_id": "000-00-0000",
"onboarding_profile": "kyc_track",
"sanction_screening": "pass",
"sanction_screening_timestamp": 1603378501286,
"self_certification_timestamp": 1667504636159,
"metadata": {},
"signed_timestamp": 1603378501286,
"signed_agreements": [
{
"type": "user_agreement",
"region": "us",
"signed_timestamp": 1603378501286
}
],
"submitter_email": "test@example.com",
"submitter_first_name": "Jon",
"submitter_last_name": "Doe",
"submitter_title": "Mr.",
"control_persons": [
{
"name": "John Smith",
"email": "test@example.com",
"address_one": "123 Main St.",
"address_two": "Suite 1000",
"city": "Chicago",
"postal_code": "12345",
"jurisdiction_code": "US-IL",
"date_of_birth": "1985-09-02",
"phone_number": "15557778888",
"citizenship_code": "US",
"tax_id": "000-00-0000",
"id_number_type": "us_passport",
"id_number": "123456789",
"id_issuing_authority": "US",
"sanction_screening": "pass",
"sanction_screening_timestamp": 1603378501286,
"kyc": "pass",
"kyc_timestamp": 1603378501286,
"control_person": 1
}
],
"beneficial_owners": [
{
"name": "John Smith",
"email": "test@example.com",
"address_one": "123 Main St.",
"address_two": "Suite 1000",
"city": "Chicago",
"postal_code": "12345",
"jurisdiction_code": "US-IL",
"date_of_birth": "1985-09-02",
"phone_number": "15557778888",
"citizenship_code": "US",
"tax_id": "000-00-0000",
"id_number_type": "us_passport",
"id_number": "123456789",
"sanction_screening": "pass",
"sanction_screening_timestamp": 1603378501286,
"kyc": "pass",
"kyc_timestamp": 1603378501286,
"beneficial_owner": 1
}
],
"incorporation_address": {
"jurisdiction_code": "IT-25"
},
"tax_residence": {
"jurisdiction_code": "PT-11"
},
"tin_jurisdiction_reason": "working_abroad",
"additional_tax_residences": [
{
"jurisdiction_code": "US-IL"
}
],
"b_notice_receipt": true,
"is_w_form_certified": true,
"w_form_certification": 1667504636159,
"signature": "signature_data",
"signature_timestamp": 1667504636159,
"payee_exemption": "NONE",
"fatca_reporting_exemption": "NONE",
"dba_name": "ABC Trading Co",
"other_entity_type": "Trust",
"w8_ben_e": {
"tax_classification": "corporation",
"ftin": "DE123456789",
"ftin_required": true,
"reference_numbers": "REF-002",
"treaty_claim": {
"is_eligible": true,
"country": "DE",
"residence_certification": true,
"income_type": "business_profits",
"withholding_rate": "0",
"article_paragraph": "Article 7",
"requirements_certification": true,
"limitation_on_benefits": "publicly_traded_corporation"
}
},
"mailing_address": {
"address_one": "10 Downing Street",
"address_two": "Apt 2",
"city": "London",
"state": "England",
"postal_code": "SW1A 2AA",
"country": "GB"
},
"merchant_category_code": "5411",
"jurisdiction_code": "US-IL"
}Response
Successfully created entity participant. Returns the created resource with generated IDs and timestamps.
Example response
{
"message": {
"platform_code": "PLAT01",
"entity_name": "Entity Name",
"legal_name": "Legal Name",
"contact_number": "15557778888",
"website": "company.com",
"date_established": "1985-09-02",
"entity_type": "llc",
"address_one": "123 Main St.",
"address_two": "Suite 1000",
"city": "Chicago",
"postal_code": "12345",
"tax_id": "000-00-0000",
"onboarding_profile": "kyc_track",
"sanction_screening": "pass",
"sanction_screening_timestamp": 1603378501286,
"self_certification_timestamp": 1667504636159,
"metadata": {},
"signed_timestamp": 1603378501286,
"signed_agreements": [
{
"type": "user_agreement",
"region": "us",
"signed_timestamp": 1603378501286
}
],
"submitter_email": "test@example.com",
"submitter_first_name": "Jon",
"submitter_last_name": "Doe",
"submitter_title": "Mr.",
"incorporation_address": {
"jurisdiction_code": "IT-25"
},
"tax_residence": {
"jurisdiction_code": "PT-11"
},
"tin_jurisdiction_reason": "working_abroad",
"b_notice_receipt": true,
"is_w_form_certified": true,
"w_form_certification": 1667504636159,
"signature": "signature_data",
"signature_timestamp": 1667504636159,
"payee_exemption": "NONE",
"fatca_reporting_exemption": "NONE",
"dba_name": "ABC Trading Co",
"other_entity_type": "Trust",
"w8_ben_e": {
"tax_classification": "corporation",
"ftin": "DE123456789",
"ftin_required": true,
"reference_numbers": "REF-002",
"treaty_claim": {
"is_eligible": true,
"country": "DE",
"residence_certification": true,
"income_type": "business_profits",
"withholding_rate": "0",
"article_paragraph": "Article 7",
"requirements_certification": true,
"limitation_on_benefits": "publicly_traded_corporation"
}
},
"mailing_address": {
"address_one": "10 Downing Street",
"address_two": "Apt 2",
"city": "London",
"state": "England",
"postal_code": "SW1A 2AA",
"country": "GB"
},
"merchant_category_code": "5411",
"merchant_category_code_category": "Grocery Stores, Supermarkets",
"merchant_category_code_classification": "transferable",
"jurisdiction_code": "US-IL",
"control_persons": [
{
"user_code": "U-XXXXXX",
"name": "John Smith",
"email": "test@example.com",
"address_one": "123 Main St.",
"address_two": "Suite 1000",
"city": "Chicago",
"postal_code": "12345",
"jurisdiction_code": "US-IL",
"date_of_birth": "1985-09-02",
"phone_number": "15557778888",
"citizenship_code": "US",
"tax_id": "000-00-0000",
"id_number_type": "us_passport",
"id_number": "123456789",
"sanction_screening": "pass",
"sanction_screening_timestamp": 1603378501286,
"kyc": "pass",
"kyc_timestamp": 1603378501286,
"control_person": 1
}
],
"beneficial_owners": [
{
"user_code": "U-XXXXXX",
"name": "John Smith",
"email": "test@example.com",
"address_one": "123 Main St.",
"address_two": "Suite 1000",
"city": "Chicago",
"postal_code": "12345",
"jurisdiction_code": "US-IL",
"date_of_birth": "1985-09-02",
"phone_number": "15557778888",
"citizenship_code": "US",
"tax_id": "000-00-0000",
"id_number_type": "us_passport",
"id_number": "123456789",
"sanction_screening": "pass",
"sanction_screening_timestamp": 1603378501286,
"kyc": "pass",
"kyc_timestamp": 1603378501286,
"beneficial_owner": 1
}
],
"participant_code": "XXXXXX",
"status": "approved"
}
}