createBusinessEntity

The createBusinessEntity mutation creates an entity with a type of business. This will enable a business to create beneficiaries and transfers.

Parameters

Please review entity schema for full parameter list

ParameterTypeRequired
user_idUUIDtrue
emailEmailtrue
phoneStringfalse
phone_countryStringfalse
contact_first_nameStringtrue
business_typeBusinessTypefalse
business_nameStringtrue
business_address1Stringtrue
contact_last_nameStringtrue
business_address2Stringfalse
business_cityStringfalse
business_state_province_regionStringfalse
business_postal_codePostalCodefalse
business_countryISO3166_1true
tax_numberTaxNumberfalse
accept_terms_and_conditionsBooleantrue

GraphQL Schema

mutation createBusinessEntity (
    $user_id: UUID!
    $email: Email!
    $phone: String
    $phone_country: String
    $contact_first_name: String!
    $contact_last_name: String!
 	  $business_type: BusinessType
    $business_name: String!
    $business_address1: String!
    $business_address2: String
    $business_city: String
    $business_state_province_region: String
    $business_postal_code: PostalCode
    $business_country: ISO3166_1!
    $tax_number: TaxNumber
    $accept_terms_and_conditions: Boolean!
) {
    createBusinessEntity (
        user_id: $user_id
        email: $email
        phone: $phone
        phone_country: $phone_country
        contact_first_name: $contact_first_name
        contact_last_name: $contact_last_name
      	business_type: $business_type
        business_name: $business_name
        business_address1: $business_address1
        business_address2: $business_address2
        business_city: $business_city
        business_state_province_region: $business_state_province_region
        business_postal_code: $business_postal_code
        business_country: $business_country
        tax_number: $tax_number
        accept_terms_and_conditions: $accept_terms_and_conditions
    )
}

Variables

{
  "user_id": "",
  "email": "",
  "phone": "",
  "contact_first_name": "",
  "contact_last_name": "",
  "business_type": "",
  "business_name": "",
  "business_address1": "",
  "business_address2": "",
  "business_city": "",
  "business_state_province_region": "",
  "business_postal_code": "",
  "business_country": "",
  "tax_number": "",
  "accept_terms_and_conditions": true
}
Language
Click Try It! to start a request and see the response here!