Jump to Content
Guides
API Reference
Changelog
v1.0
Log In
API Reference
Log In
v1.0
Guides
API Reference
Changelog
/
Search
JUMP TO
OpenAPI definition
Change Phone
Starts process of changing phone number
post
Confirms change of phone number
post
Resend SMS Verification Code
post
2FA Controller
Enrolls user to 2FA provider
post
Request login with 2FA provider.
post
Authenticate user with 2FA provider.
post
Checks if user successfully authorized with 2FA.
post
Checks if user successfully authorized transaction
post
Request approval action with 2FA provider.
post
SignUp
Start Sign Up Process
post
Resend Phone Verification Code
post
Resend Email Verification Code
post
Sign up phone
post
Verify phone
post
Finish Sign Up Process
post
Sign up verification
post
Create Password in Sign Up Process
post
Create Initial Business
post
ResetPassword
Reset Password Verify Request
post
Start Reset Password Process
post
Resend Email Verification Code
post
Forgot Password Verify Request
post
Start Forgot Password Process
post
Resend Email Verification Code
post
Login
This API represent the first step of the login process where system tries to authenticate the user
post
Verify Two Factor Authentication code and get JWT
post
Resend Email Verification Code
post
Request login with 2FA provider
post
Removes specified authenticator
post
Enrolls user to 2FA provider
post
Checks if user successfully authorized with 2FA provider
post
Retrieves 2FA provider user information
get
Transactions
Endpoint for generating JWT token for sharing transaction
get
Individual Person
/api/core/v1/me/{personId}/personal_data
put
/api/core/v1/me/{personId}/address/{addressId}
put
/api/core/v1/me/{userId}/update
post
/api/core/v1/me/{userId}/address/update
post
/api/core/v1/me
get
FX
Confirmation of exchange triggers actual transactions on account and balance changes
post
Initialize Currency Exchange
post
Find exchange quote with responses
get
Prefinery
/api/core/v1/prefinery/testers
get
/api/core/v1/prefinery/testers
post
Increment counter by 1 of given country
post
/api/core/v1/prefinery/testers/{tester_id}
get
/api/core/v1/prefinery/tester
get
Return top {count} countries sorted in descending order by counter
get
Return country user voted for
get
Conversion
Get converted value by amount.
post
Return currency rates.
get
beneficiary-controller
/api/core/v1/beneficiary
post
/api/core/v1/beneficiary/{accountNumber}
get
/api/core/v1/beneficiary/iban/{iban}/{masterAccountId}
get
/api/core/v1/beneficiary/all/{masterAccountId}
get
/api/core/v1/beneficiary/{accountNumber}/{masterAccountId}
del
Account
Creates a new account balance in the supported currencies
post
Creates Account Application
post
Account Application Webhook
post
Get account details
get
Get Business Accounts
get
Get Active Business Accounts
get
Payments
Confirms a payment from a specified account
post
Creates a new payment from an account
post
health-controller
/
get
Zefix
Get company in Zefix database by its Chid ID
get
Get all companies in Zefix database
get
validation-controller
/api/core/v1/validation/tin/{countryAlpha2Code}/{tinNumber}
get
/api/core/v1/validation/iban/{countryAlpha2Code}/{ibanNumber}
get
/api/core/v1/validation/bic/{bic}
get
Price List
Get all price list prices.
get
Get all subscriptions plans.
get
Get all subscriptions plans details.
get
Get all price list prices for master account.
get
Legal Persons
/api/core/v1/legals/{personId}
get
/api/core/v1/legals/{personId}/transactions/search
get
/api/core/v1/legals/{personId}/beneficiaries/preferred
get
/api/core/v1/legals/{personId}/accounts
get
/api/core/v1/legals/{personId}/accounts/balance/total
get
/api/core/v1/legals/{personId}/beneficiaries/{beneficiaryId}
del
Currency
Return all currencies
get
/api/core/v1/currencies/provider
get
Countries
Return a list of all known countries
get
/api/core/v1/countries/provider
get
Return a list of available countries
get
/api/core/v1/countries/alpha3
get
/api/core/v1/countries/alpha2
get
company-search-controller
/api/core/v1/company-search
get
banking-circle-controller
/api/core/v1/banking/rates/{sellCurrency}/{buyCurrency}/{amount}
get
Powered by
/
get
http://dev-lb-authentication-82368843.eu-central-1.elb.amazonaws.com/
Language
Shell
Node
Ruby
PHP
Python
Response
Click
Try It!
to start a request and see the response here!