Field

Description

id

String, Yordex generated
UUID that is unique for this trader

traderStatus

String, Yordex generated
The registration status for this trader. See possible values on the right hand side.

partnerId

String, optional
id of the partner that created this trader. If this field is not set, the trader registered directly with Yordex

traderId

String, 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.

user

Object, 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.

. email

String, mandatory
The email address of the first user for this trader

companyTradingName

String, 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

traderSlug

String, 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: https://yordex.com/get-quote/traderSlug. The trader slug can only contain alphanumeric characters.

companyRegisteredName

String, 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

companyType

String, optional
The official company type. See here for an explanation of possible company types

registrationNumber

String, optional
The official company registration number. See here for an explanation of possible registration numbers

vatNumber

String, optional
The company VAT number

website

String, optional
URL of the company’s main website

companyTradingAddress

String, optional
Company’s main trading address. When provided, only the countryCode is mandatory

companyRegisteredAddress

String, 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

relevantIndividuals

Array, 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.

. role

String, mandatory for each relevantIndividual
The relation this individual has to the company. Possible values are “OWNER”, “DIRECTOR” and "BUSINESS_CONTACT"

. name

String, mandatory for each relevantIndividual
The person’s official full name

. dateOfBirth

String, optional
The person’s date of birth using the ISO-8601 standard

. address

Object, optional
The person’s home address

. email

Object, optional
The person’s email address

. phone

Object, optional
The person’s phone number without spaces

. pctOwnership

String, 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”

bankAccount

Object, optional
The trader’s company bank account

. accountHolderName

String, mandatory when bankAccount is provided
Name of the account holder

. iban, accountNumber, accountType, bankCode, bic, branchCode, bsbCode, ifscCode, institutionNumber, routingNumber, sortCode, swiftCode, taxRegistrationNumber, transitNumber

String, optional
See table on the right which which fields are used for which countries.

. bankName

String, optional
Name of the bank.

. address

Object, optional
Address of the bank.

Trader Status

Description

REGISTERED

This 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.

CONFIRMED

At 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 fields

ISO country code

iban

AE, 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, sortCode

GB

accountNumber, accountType, routingNumber

US

iban, bic

CH, TR

accountNumber

NZ, UA

accountNumber, bankCode

HK, ID, KR, MA, PH, RU, TH

accountNumber, bsbCode

AU

accountNumber, ifscCode

IN

accountNumber, swiftCode

MY, VN, ZA

accountNumber, bankCode, branchCode

BD, LK, SG

accountNumber, bankCode, taxRegistrationNumber

MX

accountNumber, accountType, bankCode, branchCode

JP

accountNumber, accountType, institutionNumber, transitNumber

CA

accountNumber, accountType, bankCode, branchCode, taxRegistrationNumber

BR

accountNumber, BIC

All other countries