Three different types of fields are described on this page:
Traders fields
| 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 below. |
| 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. |
| 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 |
| 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 |
| traderSlug | String, optional A unique name for this trader that is used in the URL of their supplier boarding form (https://app.yordex.com/suppliers/traderSlug). This field can only contain alphanumeric characters. |
| companyType | String, optional The official company type |
| registrationNumber | String, optional The official company registration number |
| resellerId | String, optional The id for the reseller who is creating the customer |
| 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 |
| Object, optional The person’s email address | |
| . 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 |
Relations fields
| Field | Description |
|---|---|
| id | String, Yordex generated UUID that is unique for this relation |
| traderId | String, Yordex generated id of the trader that this relation is with |
| customerTraderId | String, optional The unique identifier by which this supplier is known in your systems |
| status | String, Yordex generated The approval status for this trader. The full list of relation statuses can be found on the right. |
| ownerUserId | String, optional User id of the user that owns the relation with this other company |
| approverUserId | String, optional User id of the user who approves the relation with this other company |
| traderForm | Object, optional Additional data about this trader. This is a list of free form key:value pairs |
| Relation Status | Description |
|---|---|
| INSUFFICIENT_DATA | Insufficient data available to approve the supplier. What "sufficient" is can be defined by you. |
| FOR_APPROVAL | Sufficient data available to approve the supplier but not yet approved |
| FOR_SETUP | The supplier is approved but not yet set up in your ERP system |
| COMPLETED | The supplier is approved and the data is fully synched with your ERP system |
Document fields
| Fields | Description |
|---|---|
| id | String, Yordex generated UUID that is unique for this document |
| fileName | String, Mandatory The name of the file including the extension. |
| documentId | String, Yordex generated The Id of the uploaded file |
| type | String, Mandatory The type of the document. The supported types are PASSPORT or PROOF_OF_ADDRESS |
| base64EncodedContent | String, Mandatory The content of the file in Base64 encoded format. |
| location | String, Yordex generated The download location of the document. |