Get Onboarding Config
Testing
GET
/config/onboarding
get_onboarding_config
Last modified:2025-02-06 08:23:14
Request Request Example
Shell
JavaScript
Java
Swift
curl --location -g --request GET 'https://api-core.deriv.com/v1/config/onboarding?country={{$helpers.arrayElement(['\''af'\'','\''ax'\'','\''al'\'','\''dz'\'','\''as'\'','\''ad'\'','\''ao'\'','\''ai'\'','\''aq'\'','\''ag'\'','\''ar'\'','\''am'\'','\''aw'\'','\''au'\'','\''at'\'','\''az'\'','\''bs'\'','\''bh'\'','\''bd'\'','\''bb'\'','\''by'\'','\''be'\'','\''bz'\'','\''bj'\'','\''bm'\'','\''bt'\'','\''bo'\'','\''bq'\'','\''ba'\'','\''bw'\'','\''bv'\'','\''br'\'','\''io'\'','\''bn'\'','\''bg'\'','\''bf'\'','\''bi'\'','\''cv'\'','\''kh'\'','\''cm'\'','\''ca'\'','\''ky'\'','\''cf'\'','\''td'\'','\''cl'\'','\''cn'\'','\''cx'\'','\''cc'\'','\''co'\'','\''km'\'','\''ck'\'','\''cr'\'','\''ci'\'','\''hr'\'','\''cu'\'','\''cw'\'','\''cy'\'','\''cz'\'','\''cd'\'','\''dk'\'','\''dj'\'','\''dm'\'','\''do'\'','\''ec'\'','\''eg'\'','\''sv'\'','\''gq'\'','\''er'\'','\''ee'\'','\''sz'\'','\''et'\'','\''fk'\'','\''fo'\'','\''fj'\'','\''fi'\'','\''fr'\'','\''gf'\'','\''pf'\'','\''tf'\'','\''ga'\'','\''gm'\'','\''ge'\'','\''de'\'','\''gh'\'','\''gi'\'','\''gr'\'','\''gl'\'','\''gd'\'','\''gp'\'','\''gu'\'','\''gt'\'','\''gg'\'','\''gn'\'','\''gw'\'','\''gy'\'','\''ht'\'','\''hm'\'','\''hn'\'','\''hk'\'','\''hu'\'','\''is'\'','\''in'\'','\''id'\'','\''ir'\'','\''iq'\'','\''ie'\'','\''im'\'','\''il'\'','\''it'\'','\''jm'\'','\''jp'\'','\''je'\'','\''jo'\'','\''kz'\'','\''ke'\'','\''ki'\'','\''kp'\'','\''kr'\'','\''kw'\'','\''kg'\'','\''la'\'','\''lv'\'','\''lb'\'','\''ls'\'','\''lr'\'','\''ly'\'','\''li'\'','\''lt'\'','\''lu'\'','\''mo'\'','\''mg'\'','\''mw'\'','\''my'\'','\''mv'\'','\''ml'\'','\''mt'\'','\''mh'\'','\''mq'\'','\''mr'\'','\''mu'\'','\''yt'\'','\''mx'\'','\''fm'\'','\''md'\'','\''mc'\'','\''mn'\'','\''me'\'','\''ms'\'','\''ma'\'','\''mz'\'','\''mm'\'','\''na'\'','\''nr'\'','\''np'\'','\''nl'\'','\''nc'\'','\''nz'\'','\''ni'\'','\''ne'\'','\''ng'\'','\''nu'\'','\''nf'\'','\''mk'\'','\''mp'\'','\''no'\'','\''om'\'','\''pk'\'','\''pw'\'','\''ps'\'','\''pa'\'','\''pg'\'','\''py'\'','\''pe'\'','\''ph'\'','\''pn'\'','\''pl'\'','\''pt'\'','\''pr'\'','\''qa'\'','\''cg'\'','\''re'\'','\''ro'\'','\''ru'\'','\''rw'\'','\''bl'\'','\''sh'\'','\''kn'\'','\''lc'\'','\''mf'\'','\''pm'\'','\''vc'\'','\''ws'\'','\''sm'\'','\''st'\'','\''sa'\'','\''sn'\'','\''rs'\'','\''sc'\'','\''sl'\'','\''sg'\'','\''sx'\'','\''sk'\'','\''si'\'','\''sb'\'','\''so'\'','\''za'\'','\''gs'\'','\''ss'\'','\''es'\'','\''lk'\'','\''sd'\'','\''sr'\'','\''sj'\'','\''se'\'','\''ch'\'','\''sy'\'','\''tw'\'','\''tj'\'','\''tz'\'','\''th'\'','\''tl'\'','\''tg'\'','\''tk'\'','\''to'\'','\''tt'\'','\''tn'\'','\''tr'\'','\''tm'\'','\''tc'\'','\''tv'\'','\''ug'\'','\''ua'\'','\''ae'\'','\''gb'\'','\''us'\'','\''um'\'','\''uy'\'','\''uz'\'','\''vu'\'','\''va'\'','\''ve'\'','\''vn'\'','\''vg'\'','\''vi'\'','\''wf'\'','\''eh'\'','\''ye'\'','\''zm'\'','\''zw'\''])}}' \
--header 'Authorization: {{CLIENT_AUTH_TOKEN}}' \
--header 'x-client-id: {{RL_EXCLUSION_KEY}}'Response Response Example
200 - Success
{
"data": {
"currency_selection": {
"recommended": [
{
"code": "USD",
"cashiers": [
"premier_cashier",
"p2p",
"payment_agents"
],
"label": "US Dollar",
"type": "fiat"
}
],
"other": [
{
"code": "BTC",
"cashiers": [
"coinremitter"
],
"label": "Bitcoin",
"type": "crypto"
},
{
"code": "USDC",
"cashiers": [
"coinremitter"
],
"label": "USD Coin",
"type": "crypto"
},
{
"code": "ETH",
"cashiers": [
"coinremitter"
],
"label": "Ethereum",
"type": "crypto"
},
{
"code": "LTC",
"cashiers": [
"coinremitter"
],
"label": "Litecoin",
"type": "crypto"
}
]
},
"main_goal": [
{
"label": "Hedging",
"value": "hedging"
},
{
"label": "Income earning",
"value": "income_earning"
},
{
"label": "Speculative",
"value": "speculative"
}
],
"employment_status": [
{
"label": "Employed",
"value": "employed"
},
{
"label": "Self-employed",
"value": "self_employed"
},
{
"label": "Part time",
"value": "part_time"
},
{
"label": "Unemployed",
"value": "unemployed"
},
{
"label": "Pensioner",
"value": "pensioner"
},
{
"label": "Student",
"value": "student"
}
]
},
"meta": {
"endpoint": "/config/onboarding",
"method": "GET",
"timing": 1128
}
}Request
Query Params
country
stringÂ
optional
Example:
{{$helpers.arrayElement(['af','ax','al','dz','as','ad','ao','ai','aq','ag','ar','am','aw','au','at','az','bs','bh','bd','bb','by','be','bz','bj','bm','bt','bo','bq','ba','bw','bv','br','io','bn','bg','bf','bi','cv','kh','cm','ca','ky','cf','td','cl','cn','cx','cc','co','km','ck','cr','ci','hr','cu','cw','cy','cz','cd','dk','dj','dm','do','ec','eg','sv','gq','er','ee','sz','et','fk','fo','fj','fi','fr','gf','pf','tf','ga','gm','ge','de','gh','gi','gr','gl','gd','gp','gu','gt','gg','gn','gw','gy','ht','hm','hn','hk','hu','is','in','id','ir','iq','ie','im','il','it','jm','jp','je','jo','kz','ke','ki','kp','kr','kw','kg','la','lv','lb','ls','lr','ly','li','lt','lu','mo','mg','mw','my','mv','ml','mt','mh','mq','mr','mu','yt','mx','fm','md','mc','mn','me','ms','ma','mz','mm','na','nr','np','nl','nc','nz','ni','ne','ng','nu','nf','mk','mp','no','om','pk','pw','ps','pa','pg','py','pe','ph','pn','pl','pt','pr','qa','cg','re','ro','ru','rw','bl','sh','kn','lc','mf','pm','vc','ws','sm','st','sa','sn','rs','sc','sl','sg','sx','sk','si','sb','so','za','gs','ss','es','lk','sd','sr','sj','se','ch','sy','tw','tj','tz','th','tl','tg','tk','to','tt','tn','tr','tm','tc','tv','ug','ua','ae','gb','us','um','uy','uz','vu','va','ve','vn','vg','vi','wf','eh','ye','zm','zw'])}}
Header Params
Authorization
stringÂ
optional
Example:
{{CLIENT_AUTH_TOKEN}}
x-client-id
stringÂ
optional
Default:
{{RL_EXCLUSION_KEY}}
Responses
Modified at 2025-02-06 08:23:14