Useme API docs
  1. Reference
  2. Contractors
Useme API docs
  • Guides
    • Introduction
    • Getting Started
    • Creating Contractors
    • Creating Deals
  • Reference
    • Categories
      • List categories
    • Contractors
      • Create a new contractor
        POST
    • Deals
      • Create a new deal
      • Retrieve a specific deal
      • Upload a file for a deal
  1. Reference
  2. Contractors

Create a new contractor

POST
https://sandbox.useme.com/api/1.0/contractor/
Contractors
Registers a new contractor with the given details. If the contractor already exists, it returns a conflict error.

Request

Header Params
Authorization
string 
required
Authorization token for the sandbox environment.
Default:
Token <here-paste-your-token>
Body Params application/json
email
string <email>
E-mail
required
Contractor's e-mail address
>= 1 characters
name
string 
required
Contractor's name
>= 1 characters
surname
string 
required
Contractor's surname
>= 1 characters
country_code
enum<string> 
Country
required
ISO country code (ISO 3166-1 alpha-2; two-letter uppercase)
AD - Andorra
AE - United Arab Emirates
AF - Afghanistan
AG - Antigua and Barbuda
AI - Anguilla
AL - Albania
AM - Armenia
AO - Angola
AQ - Antarctica
AR - Argentina
AS - American Samoa
AT - Austria
AU - Australia
AW - Aruba
AX - Åland Islands
AZ - Azerbaijan
BA - Bosnia and Herzegovina
BB - Barbados
BD - Bangladesh
BE - Belgium
BF - Burkina Faso
BG - Bulgaria
BH - Bahrain
BI - Burundi
BJ - Benin
BL - Saint Barthélemy
BM - Bermuda
BN - Brunei
BO - Bolivia
BQ - Bonaire, Sint Eustatius and Saba
BR - Brazil
BS - Bahamas
BT - Bhutan
BV - Bouvet Island
BW - Botswana
BY - Belarus
BZ - Belize
CA - Canada
CC - Cocos (Keeling) Islands
CD - Congo (the Democratic Republic of the)
CF - Central African Republic
CG - Congo
CH - Switzerland
CI - Côte d'Ivoire
CK - Cook Islands
CL - Chile
CM - Cameroon
CN - China
CO - Colombia
CR - Costa Rica
CU - Cuba
CV - Cabo Verde
CW - Curaçao
CX - Christmas Island
CY - Cyprus
CZ - Czechia
DE - Germany
DJ - Djibouti
DK - Denmark
DM - Dominica
DO - Dominican Republic
DZ - Algeria
EC - Ecuador
EE - Estonia
EG - Egypt
EH - Western Sahara
ER - Eritrea
ES - Spain
ET - Ethiopia
FI - Finland
FJ - Fiji
FK - Falkland Islands (Malvinas)
FM - Micronesia (Federated States of)
FO - Faroe Islands
FR - France
GA - Gabon
GB - United Kingdom
GD - Grenada
GE - Georgia
GF - French Guiana
GG - Guernsey
GH - Ghana
GI - Gibraltar
GL - Greenland
GM - Gambia
GN - Guinea
GP - Guadeloupe
GQ - Equatorial Guinea
GR - Greece
GS - South Georgia and the South Sandwich Islands
GT - Guatemala
GU - Guam
GW - Guinea-Bissau
GY - Guyana
HK - Hong Kong
HM - Heard Island and McDonald Islands
HN - Honduras
HR - Croatia
HT - Haiti
HU - Hungary
ID - Indonesia
IE - Ireland
IL - Israel
IM - Isle of Man
IN - India
IO - British Indian Ocean Territory
IQ - Iraq
IR - Iran
IS - Iceland
IT - Italy
JE - Jersey
JM - Jamaica
JO - Jordan
JP - Japan
KE - Kenya
KG - Kyrgyzstan
KH - Cambodia
KI - Kiribati
KM - Comoros
KN - Saint Kitts and Nevis
KP - North Korea
KR - South Korea
KW - Kuwait
KY - Cayman Islands
KZ - Kazakhstan
LA - Laos
LB - Lebanon
LC - Saint Lucia
LI - Liechtenstein
LK - Sri Lanka
LR - Liberia
LS - Lesotho
LT - Lithuania
LU - Luxembourg
LV - Latvia
LY - Libya
MA - Morocco
MC - Monaco
MD - Moldova
ME - Montenegro
MF - Saint Martin (French part)
MG - Madagascar
MH - Marshall Islands
MK - North Macedonia
ML - Mali
MM - Myanmar
MN - Mongolia
MO - Macao
MP - Northern Mariana Islands
MQ - Martinique
MR - Mauritania
MS - Montserrat
MT - Malta
MU - Mauritius
MV - Maldives
MW - Malawi
MX - Mexico
MY - Malaysia
MZ - Mozambique
NA - Namibia
NC - New Caledonia
NE - Niger
NF - Norfolk Island
NG - Nigeria
NI - Nicaragua
NL - Netherlands
NO - Norway
NP - Nepal
NR - Nauru
NU - Niue
NZ - New Zealand
OM - Oman
PA - Panama
PE - Peru
PF - French Polynesia
PG - Papua New Guinea
PH - Philippines
PK - Pakistan
PL - Poland
PM - Saint Pierre and Miquelon
PN - Pitcairn
PR - Puerto Rico
PS - Palestine, State of
PT - Portugal
PW - Palau
PY - Paraguay
QA - Qatar
RE - Réunion
RO - Romania
RS - Serbia
RU - Russia
RW - Rwanda
SA - Saudi Arabia
SB - Solomon Islands
SC - Seychelles
SD - Sudan
SE - Sweden
SG - Singapore
SH - Saint Helena, Ascension and Tristan da Cunha
SI - Slovenia
SJ - Svalbard and Jan Mayen
SK - Slovakia
SL - Sierra Leone
SM - San Marino
SN - Senegal
SO - Somalia
SR - Suriname
SS - South Sudan
ST - Sao Tome and Principe
SV - El Salvador
SX - Sint Maarten (Dutch part)
SY - Syria
SZ - Eswatini
TC - Turks and Caicos Islands
TD - Chad
TF - French Southern Territories
TG - Togo
TH - Thailand
TJ - Tajikistan
TK - Tokelau
TL - Timor-Leste
TM - Turkmenistan
TN - Tunisia
TO - Tonga
TR - Türkiye
TT - Trinidad and Tobago
TV - Tuvalu
TW - Taiwan
TZ - Tanzania
UA - Ukraine
UG - Uganda
UM - United States Minor Outlying Islands
US - United States of America
UY - Uruguay
UZ - Uzbekistan
VA - Holy See
VC - Saint Vincent and the Grenadines
VE - Venezuela
VG - Virgin Islands (British)
VI - Virgin Islands (U.S.)
VN - Vietnam
VU - Vanuatu
WF - Wallis and Futuna
WS - Samoa
XK - Republic of Kosovo
YE - Yemen
YT - Mayotte
ZA - South Africa
ZM - Zambia
ZW - Zimbabwe
Allowed values:
ADAEAFAGAIALAMAOAQARASATAUAWAXAZBABBBDBEBFBGBHBIBJBLBMBNBOBQBRBSBTBVBWBYBZCACCCDCFCGCHCICKCLCMCNCOCRCUCVCWCXCYCZDEDJDKDMDODZECEEEGEHERESETFIFJFKFMFOFRGAGBGDGEGFGGGHGIGLGMGNGPGQGRGSGTGUGWGYHKHMHNHRHTHUIDIEILIMINIOIQIRISITJEJMJOJPKEKGKHKIKMKNKPKRKWKYKZLALBLCLILKLRLSLTLULVLYMAMCMDMEMFMGMHMKMLMMMNMOMPMQMRMSMTMUMVMWMXMYMZNANCNENFNGNINLNONPNRNUNZOMPAPEPFPGPHPKPLPMPNPRPSPTPWPYQARERORSRURWSASBSCSDSESGSHSISJSKSLSMSNSOSRSSSTSVSXSYSZTCTDTFTGTHTJTKTLTMTNTOTRTTTVTWTZUAUGUMUSUYUZVAVCVEVGVIVNVUWFWSXKYEYTZAZMZW
street
string 
required
Street
>= 1 characters
house_no
string 
House number
optional
House number
>= 1 characters
apartment_no
string 
Apartment number
optional
Apartment number
>= 1 characters
postal_code
string 
required
Postal code
>= 1 characters<= 6 characters
city
string 
required
City
>= 1 characters
language
string 
required
Language code (two-letter lowercase; currently only 'pl' and 'en' are supported)
>= 2 characters<= 2 characters
bank_account_currency
string 
required
Bank account currency code (ISO 4217; three-letter uppercase)
>= 3 characters<= 3 characters
bank_account_iban
string 
IBAN
required
IBAN (bank account number)
>= 15 characters<= 34 characters
bank_account_bic
string 
BIC
optional
BIC/SWIFT number
>= 1 characters<= 11 characters
pesel
string 
optional
Polish tax ID for individuals
>= 1 characters<= 11 characters
nip
string 
optional
Polish tax ID for companies
>= 1 characters
tax_id
string 
optional
Tax identifier
>= 1 characters<= 30 characters
Example
{
  "email": "user@example.com",
  "name": "Name",
  "surname": "Surname",
  "country_code": "AT",
  "street": "Street",
  "house_no": "50",
  "apartment_no": "5",
  "postal_code": "5020",
  "city": "City",
  "language": "en",
  "bank_account_currency": "EUR",
  "bank_account_iban": "AT611904300234573201",
  "bank_account_bic": "SANTATWWXXX",
  "tax_id": "22-345/6781"
}

Request samples

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request POST 'https://sandbox.useme.com/api/1.0/contractor/' \
--header 'Authorization;' \
--header 'Content-Type: application/json' \
--data-raw '{
    "email": "user@example.com",
    "name": "Name",
    "surname": "Surname",
    "country_code": "AT",
    "street": "Street",
    "house_no": "50",
    "apartment_no": "5",
    "postal_code": "5020",
    "city": "City",
    "language": "en",
    "bank_account_currency": "EUR",
    "bank_account_iban": "AT611904300234573201",
    "bank_account_bic": "SANTATWWXXX",
    "tax_id": "22-345/6781"
}'

Responses

🟢201Returns the newly created contractor's email.
application/json
Body
success
boolean 
optional
Default:
true
data
object (ContractorData) 
required
contractor_email
string <email>
required
Example
{
  "success": true,
  "data": {
    "contractor_email": "user@example.com"
  }
}
🟠400Invalid input parameters or validation errors returned by the serializer.
🟠409Indicates that the contractor already exists.
Modified at 2024-05-07 08:34:28
Previous
List categories
Next
Create a new deal
Built with