{"activeVersionTag":"latest","latestAvailableVersionTag":"latest","collection":{"info":{"_postman_id":"a04d7ccf-12d1-41e2-b734-cc2569b79790","name":"Celsius API","description":"# Getting Started\n\nThis postman collection contains endpoints usable by Celsius partners.\n\n# Authentication\n\nDepending on the integration type, different authentication headers are used.\n\n**Note** All examples are using the Segmented Integration authentication headers (`X-Cel-Partner-Token`/`X-Cel-User-Token`).  \nIn case you are using one of the Omnibus Integrations, replace `X-Cel-User-Token` with `X-Cel-Api-Key` header.\n\n## Segmented Integration\n\nSegmented Integration partners use the `partner key` (issued by Celsius and securely provided to the partner) and a `user token` (created by the partner for each user they want to create in Celsius system) in order to authenticate on behalf of their users.\n\nHere are the headers that need to be set to authenticate:\n\n| Header            | Description                                                                                    |\n|-------------------|------------------------------------------------------------------------------------------------|\n| X-Cel-Partner-Token | Partner key provided by Celsius, used to differentiate between partners                        |\n| X-Cel-User-Token  | User token created by the partner for each user, used to differentiate between partner's users |\n\n## Omnibus Integrations\n\nOmnibus and Omnibus Treasury partners use the `partner key` (issued by Celsius and securely provided to the partner) and an `api key` (issued by Celsius and securely provided to the partner) in order to authenticate.\n\nHere are the headers that need to be set to authenticate:\n\n| Header            | Description                                                                                    |\n|-------------------|------------------------------------------------------------------------------------------------|\n| X-Cel-Partner-Token | Partner key provided by Celsius, used to differentiate between partners                        |\n| X-Cel-Api-Key  | Api key provided by Celsius, used to authenticate as the partner |\n\n\n# Data Structures\n\nExplanation for each data structure used by the Celsius API, and their properties, can be found in the tables below.\n\n## Transaction\n\nAn instance of Transaction structure represents a single transaction of a user in Celsius system.\n\n| Property           | Type           | Description                                                            |\n|----------------|----------------|------------------------------------------------------------------------|\n| id             | uuid           | Transaction id in Celsius system                                       |\n| amount         | numeric string | Transaction amount, rounded down to the last significant decimal place |\n| amount_precise | numeric string | Precise transaction amount, without any rounding applied               |\n| amount_usd     | numeric string | Transaction amount converted to USD at the `time` property             |\n| coin           | string         | Transaction coin                                                       |\n| state          | string         | [Transaction State](#transaction-state)                                                      |\n| nature         | string         | [Transaction Nature](#transaction-nature)                                                     |\n| time           | ISO 8601 date  | Transaction date and time                                              |\n| tx_id          | string         | Transaction blockchain hash                                            |\n| original_interest_coin | string | Original coin for which this transaction was created. Present only when the `nature` property is `interest` |\n| interest_amount_in_original_coin | numeric string | Amount in `original_interest_coin` before conversion to `coin`. Present only when the `nature` property is `interest` |\n\n## Transaction State\n\nTransaction State represents the different states that the `state` property of [Transaction](#transaction) can have. \n\n| State       | State Type   | Description                                         |\n|-------------|--------------|-----------------------------------------------------|\n| processing  | Intermediate | Transaction is waiting to be sent to the blockchain |\n| unconfirmed | Intermediate | Transaction is waiting to be confirmed              |\n| confirmed   | Final        | Transaction is confirmed                            |\n| rejected    | Final        | Transaction wasn't confirmed and has failed         |\n\n## Transaction Nature\n\nTransaction Nature represents the different natures that the `nature` property of [Transaction](#transaction) can have\n\n| Nature     | Description            |\n|------------|------------------------|\n| deposit    | Deposit transaction    |\n| withdrawal | Withdrawal transaction |\n| interest   | Interest transaction   |\n\n## Pagination\n\nPagination structure is used to split any collection into pages, each with the same number of items.\n\n| Property     | Type    | Description                                                                                     |\n|----------|---------|-------------------------------------------------------------------------------------------------|\n| total    | numeric | Total number of items                                                             |\n| pages    | numeric | Total number of pages, each with `per_page` number of items                              |\n| current  | numeric | Current page number                                                                             |\n| per_page | numeric | Number of items per page                                                                 |\n| showing  | string  | Where in the collection are the first and last item located |\n\n## Interest Rate\n\nInterest Rate structure is used to represent interest rate for a single coin.\n\n| Property     | Type    | Description                                                                                     |\n|----------|---------|-------------------------------------------------------------------------------------------------|\n| coin    | string | Interest rate coin                                                             |\n| rate    | numeric string | Interest rate                              |\n\n## Accrued Interest\n\nAccrued Interest structure is used to represent the interest a user has accrued for a single coin.\n\n| Property     | Type    | Description                                                                                     |\n|----------|---------|-------------------------------------------------------------------------------------------------|\n| amount | numeric string | Interest accrued In Kind (Interest accrued in coin for holdings in that same coin)                                                            |\n| amount_cel | numeric string | Interest accrued In CEL (Interest accrued in CEl on holdings in the coin)\n| amount_usd    | number | Interest accrued converted to USD. This includes both In Kind and In CEL interest                              |\n| coin | string | Coin on which the interest was accrued |\n\n## KYC Status\n\nKYC Status represents the different statuses that a KYC application can have.\n\n| Status               | Status Type  | Description                                                                                               |\n|----------------------|--------------|-----------------------------------------------------------------------------------------------------------|\n| COLLECTING           | Intermediate | Data still needs to be uploaded before the KYC verification can start                                     |\n| PENDING              | Intermediate | KYC verification is in progress                                                                           |\n| PASSED               | Final        | KYC application has passed the verification                                                               |\n| REJECTED             | Final        | KYC application has failed the verification. Data needs to be resubmitted to restart the KYC verification |\n| PERMANENTLY_REJECTED | Final        | KYC application has been permanently rejected. Another KYC verification can't be started for this user    |\n\n## Rejection Reason\n\nRejection Reason represents a reason why a KYC application has failed the verification process.\nMultiple reasons can be provided for the same KYC application.\n\nFor a description of each reason, consult the [OnFido Documentation](https://documentation.onfido.com/#breakdowns)\n\n| Rejection Reason |\n| ---------------- |\n| politically_exposed_person | \n| legal_and_regulatory_warnings | \n| sanction | \n| adverse_media | \n| image_quality | \n| image_integrity | \n| conclusive_document_quality | \n| mrz | \n| supported_document | \n| fonts | \n| document_numbers | \n| digital_tampering | \n| original_document_present | \n| visual_authenticity | \n| picture_face_integrity | \n| face_detection | \n| security_features | \n| data_validation | \n| last_name | \n| first_name | \n| date_of_birth | \n| data_consistency | \n| gender | \n| minimum_accepted_age | \n| age_validation | \n| document_expiration | \n| expiry_date | \n| colour_picture | \n| other | \n| template | ","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","isPublicCollection":false,"owner":"4207695","team":159420,"collectionId":"a04d7ccf-12d1-41e2-b734-cc2569b79790","publishedId":"Rzn6v2mZ","public":true,"publicUrl":"https://documenter-api.postman.tech/view/4207695/Rzn6v2mZ","privateUrl":"https://go.postman.co/documentation/4207695-a04d7ccf-12d1-41e2-b734-cc2569b79790","customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"EF5B25"},"documentationLayout":"classic-double-column","version":"8.10.1","publishDate":"2018-12-19T17:15:34.000Z","activeVersionTag":"latest","documentationTheme":"light","metaTags":{},"logos":{}},"statusCode":200},"environments":[{"name":"Sandbox","id":"ea02fd3f-c53f-4851-bf01-103ec819704d","owner":"4207695","values":[{"key":"base_url","value":"https://wallet-api.staging.celsius.network","enabled":true},{"key":"test_partner_token","value":"27ad54f93337ddf5ac9b3c3df7623d05","enabled":true},{"key":"test_user_token","value":"7b6e492f1a222026f8467ebeeaa3e559","enabled":true},{"key":"test_api_key","value":"9af4d8381781baccb0f915e554f8798d","enabled":true}],"published":true}],"user":{"authenticated":false,"permissions":{"publish":false}},"run":{"button":{"js":"https://run.pstmn.io/button.js","css":"https://run.pstmn.io/button.css"}},"web":"https://www.getpostman.com/","team":{"logo":"https://res.cloudinary.com/postman/image/upload/t_team_logo_pubdoc/v1/team/dab669d2d042602bbe0e17fa3df4a06667d39e239d5073b37fa0d4275f81186e","favicon":""},"isEnvFetchError":false,"languages":"[{\"key\":\"csharp\",\"label\":\"C#\",\"variant\":\"HttpClient\"},{\"key\":\"csharp\",\"label\":\"C#\",\"variant\":\"RestSharp\"},{\"key\":\"curl\",\"label\":\"cURL\",\"variant\":\"cURL\"},{\"key\":\"dart\",\"label\":\"Dart\",\"variant\":\"http\"},{\"key\":\"go\",\"label\":\"Go\",\"variant\":\"Native\"},{\"key\":\"http\",\"label\":\"HTTP\",\"variant\":\"HTTP\"},{\"key\":\"java\",\"label\":\"Java\",\"variant\":\"OkHttp\"},{\"key\":\"java\",\"label\":\"Java\",\"variant\":\"Unirest\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"Fetch\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"jQuery\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"XHR\"},{\"key\":\"c\",\"label\":\"C\",\"variant\":\"libcurl\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Axios\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Native\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Request\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Unirest\"},{\"key\":\"objective-c\",\"label\":\"Objective-C\",\"variant\":\"NSURLSession\"},{\"key\":\"ocaml\",\"label\":\"OCaml\",\"variant\":\"Cohttp\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"cURL\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"Guzzle\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"HTTP_Request2\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"pecl_http\"},{\"key\":\"powershell\",\"label\":\"PowerShell\",\"variant\":\"RestMethod\"},{\"key\":\"python\",\"label\":\"Python\",\"variant\":\"http.client\"},{\"key\":\"python\",\"label\":\"Python\",\"variant\":\"Requests\"},{\"key\":\"r\",\"label\":\"R\",\"variant\":\"httr\"},{\"key\":\"r\",\"label\":\"R\",\"variant\":\"RCurl\"},{\"key\":\"ruby\",\"label\":\"Ruby\",\"variant\":\"Net::HTTP\"},{\"key\":\"shell\",\"label\":\"Shell\",\"variant\":\"Httpie\"},{\"key\":\"shell\",\"label\":\"Shell\",\"variant\":\"wget\"},{\"key\":\"swift\",\"label\":\"Swift\",\"variant\":\"URLSession\"}]","languageSettings":[{"key":"csharp","label":"C#","variant":"HttpClient"},{"key":"csharp","label":"C#","variant":"RestSharp"},{"key":"curl","label":"cURL","variant":"cURL"},{"key":"dart","label":"Dart","variant":"http"},{"key":"go","label":"Go","variant":"Native"},{"key":"http","label":"HTTP","variant":"HTTP"},{"key":"java","label":"Java","variant":"OkHttp"},{"key":"java","label":"Java","variant":"Unirest"},{"key":"javascript","label":"JavaScript","variant":"Fetch"},{"key":"javascript","label":"JavaScript","variant":"jQuery"},{"key":"javascript","label":"JavaScript","variant":"XHR"},{"key":"c","label":"C","variant":"libcurl"},{"key":"nodejs","label":"NodeJs","variant":"Axios"},{"key":"nodejs","label":"NodeJs","variant":"Native"},{"key":"nodejs","label":"NodeJs","variant":"Request"},{"key":"nodejs","label":"NodeJs","variant":"Unirest"},{"key":"objective-c","label":"Objective-C","variant":"NSURLSession"},{"key":"ocaml","label":"OCaml","variant":"Cohttp"},{"key":"php","label":"PHP","variant":"cURL"},{"key":"php","label":"PHP","variant":"Guzzle"},{"key":"php","label":"PHP","variant":"HTTP_Request2"},{"key":"php","label":"PHP","variant":"pecl_http"},{"key":"powershell","label":"PowerShell","variant":"RestMethod"},{"key":"python","label":"Python","variant":"http.client"},{"key":"python","label":"Python","variant":"Requests"},{"key":"r","label":"R","variant":"httr"},{"key":"r","label":"R","variant":"RCurl"},{"key":"ruby","label":"Ruby","variant":"Net::HTTP"},{"key":"shell","label":"Shell","variant":"Httpie"},{"key":"shell","label":"Shell","variant":"wget"},{"key":"swift","label":"Swift","variant":"URLSession"}],"languageOptions":[{"label":"C# - HttpClient","value":"csharp - HttpClient - C#"},{"label":"C# - RestSharp","value":"csharp - RestSharp - C#"},{"label":"cURL - cURL","value":"curl - cURL - cURL"},{"label":"Dart - http","value":"dart - http - Dart"},{"label":"Go - Native","value":"go - Native - Go"},{"label":"HTTP - HTTP","value":"http - HTTP - HTTP"},{"label":"Java - OkHttp","value":"java - OkHttp - Java"},{"label":"Java - Unirest","value":"java - Unirest - Java"},{"label":"JavaScript - Fetch","value":"javascript - Fetch - JavaScript"},{"label":"JavaScript - jQuery","value":"javascript - jQuery - JavaScript"},{"label":"JavaScript - XHR","value":"javascript - XHR - JavaScript"},{"label":"C - libcurl","value":"c - libcurl - C"},{"label":"NodeJs - Axios","value":"nodejs - Axios - NodeJs"},{"label":"NodeJs - Native","value":"nodejs - Native - NodeJs"},{"label":"NodeJs - Request","value":"nodejs - Request - NodeJs"},{"label":"NodeJs - Unirest","value":"nodejs - Unirest - NodeJs"},{"label":"Objective-C - NSURLSession","value":"objective-c - NSURLSession - Objective-C"},{"label":"OCaml - Cohttp","value":"ocaml - Cohttp - OCaml"},{"label":"PHP - cURL","value":"php - cURL - PHP"},{"label":"PHP - Guzzle","value":"php - Guzzle - PHP"},{"label":"PHP - HTTP_Request2","value":"php - HTTP_Request2 - PHP"},{"label":"PHP - pecl_http","value":"php - pecl_http - PHP"},{"label":"PowerShell - RestMethod","value":"powershell - RestMethod - PowerShell"},{"label":"Python - http.client","value":"python - http.client - Python"},{"label":"Python - Requests","value":"python - Requests - Python"},{"label":"R - httr","value":"r - httr - R"},{"label":"R - RCurl","value":"r - RCurl - R"},{"label":"Ruby - Net::HTTP","value":"ruby - Net::HTTP - Ruby"},{"label":"Shell - Httpie","value":"shell - Httpie - Shell"},{"label":"Shell - wget","value":"shell - wget - Shell"},{"label":"Swift - URLSession","value":"swift - URLSession - Swift"}],"layoutOptions":[{"value":"classic-single-column","label":"Single Column"},{"value":"classic-double-column","label":"Double Column"}],"versionOptions":[],"environmentOptions":[{"value":"0","label":"No Environment"},{"label":"Sandbox","value":"4207695-ea02fd3f-c53f-4851-bf01-103ec819704d"}],"canonicalUrl":"https://documenter.gw.postman.com/view/metadata/Rzn6v2mZ"}