{"activeVersionTag":"latest","latestAvailableVersionTag":"latest","collection":{"info":{"_postman_id":"e47132a8-360b-46f8-9804-de0823712188","name":"KERI API (BP)","description":"### Data Types\n\n#### **QuestionInfo**\n\n| Field | **Type** | Description |\n| --- | --- | --- |\n| q | Integer | The index of the word in the recovery phrase to be verified. |\n| a | \\[String\\] | A list of three choices for the user to select. |\n\n#### **AnswerInfo**\n\n| **Parameter** | **Type** | **Description** |\n| --- | --- | --- |\n| q | Integer | The index of the word in the recovery phrase. |\n| a | String | The user's selected answer |\n\n#### **AuthInfo**\n\n| **Field** | **Type** | **Description** |\n| --- | --- | --- |\n| token | String | The access token to be used for authenticated requests. |\n| type | String | The token type. |\n| expires_at | String | The expiration time of the token. |\n\n#### **UserInfo**\n\n| **Field** | **Type** | **Description** |\n| --- | --- | --- |\n| uid | String | Unique user ID |\n| name | String | The user's account name. |\n| handle | String | A generated user handle. |\n| mobile_number | String | User's registered mobile number |\n| email | String | User's registered email address |\n| is_mobile_number_verified | Boolean | Indicates whether the registered mobile number is already verified. |\n| is_email_verified | Boolean | Indicates whether the registered email address is already verified. |\n| avatar | String | User's avatar image URL |\n| wallets | \\[WalletInfo\\] | An array of wallets associated with the user. |\n| kyc | KYCInfo | User's KYC information |\n\n#### **WalletInfo**\n\n| **Field** | **Type** | **Description** |\n| --- | --- | --- |\n| uuid | String | The wallet's unique identifier |\n| number | String | The wallet number. |\n| name | String | The wallet name. |\n| handle | String | A generated wallet handle. |\n| balance | BalanceInfo | The current balance of the wallet. |\n| is_main | Boolean | Indicates whether this is the primary wallet. |\n| link | String | The generated static cash-in link. |\n\n#### **BalanceInfo**\n\n| **Field** | **Type** | **Description** |\n| --- | --- | --- |\n| currency | String | The currency of the wallet balance. |\n| value | Double | The remaining balance of the wallet. |\n\n#### **KYCInfo**\n\n| **Field** | **Type** | **Description** |\n| --- | --- | --- |\n| message | String | KYC verification message. |\n| status | String | KYC verification status. Initial value is `1000` |\n| requisites | \\[KYCRequisiteInfo\\] | An array containing all additional documents needed for the KYC verification. |\n| consent | KYCConsentInfo | Netbank consent details. |\n\n#### **KYCRequisiteInfo**\n\n| **Field** | **Type** | **Description** |\n| --- | --- | --- |\n| type | String | The additional document needed. |\n| description | String | Description of the additional document needed. |\n| date | String |  |\n\n#### **KYCConsentInfo**\n\n| **Field** | **Type** | **Description** |\n| --- | --- | --- |\n| url | String | Netbank Consent URL |\n| is_consented | Boolean | Indicates whether the user have consented KERI to make changes in his/her Netbank account. |\n\n#### **ExternalAccountInfo**\n\n| **Parameter** | **Type** | **Description** |\n| --- | --- | --- |\n| bank | String | The recipient's bank. |\n| name | String | The recipient's account name. |\n| account_number | String | The recipient's account number. |\n| settlement_rail | String | The channel to be used by the transaction (`INSTAPAY`/`PESONET`). |\n\n#### **InternalAccountInfo**\n\n| **Parameter** | **Type** | **Description** |\n| --- | --- | --- |\n| wallet | WalletInfo | The wallet details |\n\n#### **BankInfo**\n\n| **Parameter** | **Type** | **Description** |\n| --- | --- | --- |\n| bank | String | The name of the bank. |\n| slug | String | The slug of the bank. |\n| logo | String | The image url of the logo of the bank. |\n| settlement_rails | \\[SettlementRailInfo\\] | The available channels of the bank. |\n\n#### **SettlementRailInfo**\n\n| **Parameter** | **Type** | **Description** |\n| --- | --- | --- |\n| rail | String | The name of the settlement rail/channel. |\n| code | String | The bank's code. |\n\n#### **RecentInternalTransferInfo**\n\n| **Parameter** | **Type** | **Description** |\n| --- | --- | --- |\n| uuid | String | The transaction's unique identifier. |\n| name | String | The destination wallet name. |\n| description | String | The transaction message or description. |\n| account_number | String | The destination wallet number. |\n\n#### **FavoriteInternalTransferInfo**\n\n| **Parameter** | **Type** | **Description** |\n| --- | --- | --- |\n| uuid | String | The transaction's unique identifier. |\n| name | String | The favorite's name. |\n| description | String | The transaction message or description. |\n| account_number | String | The destination wallet number. |\n| is_pinned | Boolean | Indicates whether this is pinned or not. |\n\n#### **WalletTransactionInfo**\n\n| **Parameter** | **Type** | **Description** |\n| --- | --- | --- |\n| type | String | The transaction type. (`DEPOSIT`, `SEND`, `RECEIVE`, `WITHDRAW`, `PURCHASE`) |\n| sender | String | The transaction's source. |\n| recipient | String | The transaction's destination. |\n| reference_no | String | The transaction's reference number. |\n| external_reference_no | String | The transaction's external reference number. |\n| description | String | The transaction message or description. |\n| currency | String | The transaction's currency. |\n| amount | String | The transaction's amount. |\n| fee | String | The transaction's service/convenience fee. |\n| total | String | The sum of `amount` and `fee`. |\n| status | String | The transaction's status. (`PENDING`, `COMPLETED`, `CANCELLED`, `FAILED`) |\n| date | String | The transaction's date and time. |\n\n#### **NotificationInfo**\n\n| **Parameter** | **Type** | **Description** |\n| --- | --- | --- |\n| uuid | String | The notification's unique identifier. |\n| type | String | The notification type. |\n| title | String | The notification title. |\n| description | String | The notification description. |\n| date | String | The date of the notification. |\n| is_read | Boolean | Indicates whether the notification has been read. |\n\n#### **PaginationInfo**\n\n| **Parameter** | **Type** | **Description** |\n| --- | --- | --- |\n| current_page | Int | The current page of the paginated list. |\n| per_page | Int | The number of elements per page/list. |\n\n#### **IDFormValueInfo**\n\n| **Parameter** | **Type** | **Description** |\n| --- | --- | --- |\n| id | Int | The ID's unique identifier. |\n| name | String | The ID's name. |\n| value | String | The ID's ZOLOZ unique identifier. |\n\n#### **CountryFormValueInfo**\n\n| **Parameter** | **Type** | **Description** |\n| --- | --- | --- |\n| id | Int | The country's unique identifier. |\n| name | String | The country's name. |\n\n#### **GenderFormValueInfo**\n\n| **Parameter** | **Type** | **Description** |\n| --- | --- | --- |\n| id | Int | The gender's unique identifier. |\n| name | String | The gender's name. |\n\n#### **AddressFormValueInfo**\n\n| **Parameter** | **Type** | **Description** |\n| --- | --- | --- |\n| provinces | \\[ProvinceFormValueInfo\\] | The array of provinces. |\n\n#### **ProvinceFormValueInfo**\n\n| **Parameter** | **Type** | **Description** |\n| --- | --- | --- |\n| id | Int | The province's unique identifier. |\n| name | String | The province's name. |\n| cities | \\[CityFormValueInfo\\] | The province's name |\n\n#### **CityFormValueInfo**\n\n| **Parameter** | **Type** | **Description** |\n| --- | --- | --- |\n| id | Int | The city's unique identifier. |\n| name | String | The city's name. |\n| zip_code | String | The city's zip code. |\n\n#### **KYCIDInfo**\n\n| **Parameter** | **Type** | **Description** |\n| --- | --- | --- |\n| type | Request: Int  <br>Response: String | The type of ID used in KYC verification. |\n\n#### **KYCProfileInfo**\n\n| **Parameter** | **Type** | **Description** |\n| --- | --- | --- |\n| id_number | String | The ID number. |\n| expiration_date | String | The ID's expiration date. |\n| first_name | String | The user's first name. |\n| middle_name | String | The user's middle name. |\n| no_middle_name | Boolean | Indicates whether the user has middle name. |\n| last_name | String | The user's last name. |\n\n#### **KYCPersonalInfo**\n\n| **Parameter** | **Type** | **Description** |\n| --- | --- | --- |\n| nationality | String | The user's nationality. |\n| country_of_birth | Request: Int  <br>Response: String | The user's country of birth. |\n| birth_place | String | The user's birth place. |\n| date_of_birth | String | The user's birthdate. |\n| sex | Request: Int  <br>Response: String | The user's gender. |\n| mobile_number | String | The user's mobile number. |\n\n#### **KYCAddressInfo**\n\n| **Parameter** | **Type** | **Description** |\n| --- | --- | --- |\n| country | Request: Int  <br>Response: String | The user's country of residence. |\n| province | Request: Int  <br>Response: String | The user's province of residence. |\n| city | Request: Int  <br>Response: String | The user's city of residence. |\n| address | String | The user's address. |\n| zip_code | String | The user's zip code. |\n\n#### **KYCOthersInfo**\n\n| **Parameter** | **Type** | **Description** |\n| --- | --- | --- |\n| zoloz_transaction_id | String | The ZOLOZ transaction ID for the KYC process. |\n| signature | String | The base64 representation of user's signature. |\n\n#### **KYCExtraDocumentInfo**\n\n| **Parameter** | **Type** | **Description** |\n| --- | --- | --- |\n| id_type | String | The ID type of the document. |\n| id_number | String | The ID number of the document. |\n| country | String | The country registered in the document. |\n| expiration_date | String | The expiration date of the document. |","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","isPublicCollection":false,"owner":"16162125","team":1508310,"collectionId":"e47132a8-360b-46f8-9804-de0823712188","publishedId":"2sAYJAdGzT","public":true,"publicUrl":"https://bp-api-doc.keri.app","privateUrl":"https://go.postman.co/documentation/16162125-e47132a8-360b-46f8-9804-de0823712188","customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"0A5DD9"},"documentationLayout":"classic-double-column","customisation":{"metaTags":[{"name":"description","value":""},{"name":"title","value":""}],"appearance":{"default":"light","themes":[{"name":"dark","logo":"https://content.pstmn.io/335ba76f-38f7-4569-9598-ea724206f56c/bG9nby5wbmc=","colors":{"top-bar":"212121","right-sidebar":"303030","highlight":"0A5DD9"}},{"name":"light","logo":"https://content.pstmn.io/335ba76f-38f7-4569-9598-ea724206f56c/bG9nby5wbmc=","colors":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"0A5DD9"}}]}},"version":"8.10.1","publishDate":"2025-01-09T01:46:08.000Z","activeVersionTag":"latest","documentationTheme":"light","metaTags":{"title":"","description":""},"logos":{"logoLight":"https://content.pstmn.io/335ba76f-38f7-4569-9598-ea724206f56c/bG9nby5wbmc=","logoDark":"https://content.pstmn.io/335ba76f-38f7-4569-9598-ea724206f56c/bG9nby5wbmc="}},"statusCode":200},"environments":[{"name":"KERI [DEV]","id":"4d786a32-c00b-4a17-a5df-c9a8ec5ae88a","owner":"16162125","values":[{"key":"host","value":"api-dev.keri.app","enabled":true,"type":"default"},{"key":"token","value":"22|jCkO365g8N7fH0XhXFwV5UH09RxTuF7BoiLbz61U70e27d14","enabled":true,"type":"default"},{"key":"session_id","value":"niSg9FrUaDNeCeYP8ywKhadONoyyvzVn3jujtMh24AbdY97ImefzxkqvoFO0yuLK0dd46319","enabled":true,"type":"default"},{"key":"recovery_phrase","value":"","enabled":true,"type":"any"},{"key":"q1","value":"1","enabled":true,"type":"default"},{"key":"q2","value":"2","enabled":true,"type":"default"},{"key":"q3","value":"3","enabled":true,"type":"default"},{"key":"a1","value":"","enabled":true,"type":"default"},{"key":"a2","value":"","enabled":true,"type":"default"},{"key":"a3","value":"","enabled":true,"type":"default"}],"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/fd7e189613eab1f405136dcec9e568e159d11412f199771fcd420b0e026e6fa2","favicon":"https://res.cloudinary.com/postman/image/upload/v1631529348/team/gt4itlakouvnzdtueglb.ico"},"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":"KERI [DEV]","value":"16162125-4d786a32-c00b-4a17-a5df-c9a8ec5ae88a"}],"canonicalUrl":"https://bp-api-doc.keri.app/view/metadata/2sAYJAdGzT"}