idString, Yordex generated
UUID that is unique for this trader
traderStatusString, Yordex generated
The registration status for this trader. See possible values on the right hand side.
partnerIdString, optional
id of the partner that created this trader. If this field is not set, the trader registered directly with Yordex
traderIdString, optional
id of the trader A that created this trader B. Specifying this field will allow trader A to edit the details of trader B. As soon as trader B creates their own account on Yordex, they will start maintaining their own trader details.
userObject, mandatory
The details of the first user for this trader. This field is only used for the request body when creating a trader. It is not returned in the response.
. emailString, mandatory
The email address of the first user for this trader
companyTradingNameString, optional
The company trading name for this trader. This field is optional when creating the trader but mandatory when approving the first order for this trader
traderSlugString, optional
Every trader has their own order form which is accessible to any buyer, even if that buyer does not have their own Yordex account. The URL of that page is: The trader slug can only contain alphanumeric characters.
companyRegisteredNameString, optional
The official name by which this company is registered. If this name is not provided, it is assumed that this is the same as the companyTradingName
companyTypeString, optional
The official company type. See here for an explanation of possible company types
registrationNumberString, optional
The official company registration number. See here for an explanation of possible registration numbers
vatNumberString, optional
The company VAT number
websiteString, optional
URL of the company’s main website
companyTradingAddressString, optional
Company’s main trading address. When provided, only the countryCode is mandatory
companyRegisteredAddressString, optional
The official address where this company is based. If this address is not provided, it is assumed that this is the same as the companyTradingAddress
relevantIndividualsArray, optional
As part of our regulatory requirements, we have to identify key individuals, including beneficial owners holding more than a 25% share in the company and company directors. You will find more more information about this process here. All these individuals should be reported in this array.
. roleString, mandatory for each relevantIndividual
The relation this individual has to the company. Possible values are “OWNER”, “DIRECTOR” and "BUSINESS_CONTACT"
. nameString, mandatory for each relevantIndividual
The person’s official full name
. dateOfBirthString, optional
The person’s date of birth using the ISO-8601 standard
. addressObject, optional
The person’s home address
. emailObject, optional
The person’s email address
. phoneObject, optional
The person’s phone number without spaces
. pctOwnershipString, optional
The percentage of shares of the trader this person owns. If the person owns 30%, the value for this field should be 30. This field only needs to be provided when the role of this person is “OWNER”
bankAccountObject, optional
The trader’s company bank account
. accountHolderNameString, mandatory when bankAccount is provided
Name of the account holder
. iban, accountNumber, accountType, bankCode, bic, branchCode, bsbCode, ifscCode, institutionNumber, routingNumber, sortCode, swiftCode, taxRegistrationNumber, transitNumberString, optional
See table on the right which which fields are used for which countries.
. bankNameString, optional
Name of the bank.
. addressObject, optional
Address of the bank.
Trader StatusDescription
REGISTEREDThis trader has not yet confirmed their email address which means that either they did not yet click the confirmation link or their account was created by someone else.
CONFIRMEDAt least one of the users of this trader has confirmed their email address. Only the trader themselves can make updates to their account details
Bank account fieldsISO country code
ibanAE, AT, BE, BG, CY, CZ, DE, DK, EE, ES, FI, FR, GE, GR, HU, IE, IT, LT, LU, LV, MT, NL, NO, PK, PL, PT, RO, SE, SI, SK
accountNumber, sortCodeGB
accountNumber, accountType, routingNumberUS
iban, bicCH, TR
accountNumberNZ, UA
accountNumber, bankCodeHK, ID, KR, MA, PH, RU, TH
accountNumber, bsbCodeAU
accountNumber, ifscCodeIN
accountNumber, swiftCodeMY, VN, ZA
accountNumber, bankCode, branchCodeBD, LK, SG
accountNumber, bankCode, taxRegistrationNumberMX
accountNumber, accountType, bankCode, branchCodeJP
accountNumber, accountType, institutionNumber, transitNumberCA
accountNumber, accountType, bankCode, branchCode, taxRegistrationNumberBR
accountNumber, BICAll other countries