---
name: "getAccountInfo"
mode: "kit"
versionRequirements:
  - { name: "MiniKit", version: "3.1.0" }
  - { name: "@ray-js/ray", version: "0.9.0" }
platform:
  - "iOS"
  - "Android"
async: true
---

## getAccountInfo

> [VERSION] MiniKit >= 3.1.0 | @ray-js/ray >= 0.9.0

> [PLATFORM] iOS, Android

> ⚡ **Supports Promise** — Returns a Promise when success / fail / complete callbacks are omitted.

### Description

Get mini app account information

### Parameters

| Property | Type | Required | Default | Description |
| --- | --- | --- | --- | --- |
| `complete` | `() => void` | No | - | Completion callback (executed on both success and failure) |
| `success` | `(params: Object) => void` ↓see below | No | - | Callback on successful API call |
| `fail` | `(params: Object) => void` ↓see below | No | - | Failure callback |

#### success callback parameters

| Property | Type | Since | Description |
| --- | --- | --- | --- |
| `miniProgram` | `MiniProgramAccountInfo` | `3.2.0` | Mini app account information |

#### fail callback parameters

| Property | Type | Description |
| --- | --- | --- |
| `errorMsg` | `string` | Error message |
| `errorCode` | `string \| number` | Error code |
| `innerError` | `Object` | Error extension |

##### fail(params).innerError properties

| Property | Type | Description |
| --- | --- | --- |
| `errorCode` | `string \| number` | Error extension code |
| `errorMsg` | `string` | Error extension message |


### Referenced Types

##### `interface` MiniProgramAccountInfo

| Property | Type | Since | Description |
| --- | --- | --- | --- |
| `appId` | `string` | `3.2.0` | Mini App appId |
| `envVersion` | `string` | `3.2.0` | Mini App version develop: Development trail: Trial release: Release |
| `version` | `string` | `3.2.0` | Mini App version number |
| `appName` | `string` | `3.12.1` | Mini App name |
| `appIcon` | `string` | `3.12.1` | Mini App icon |
| `providerType` | `string` | `3.23.0` | Mini App provider type third: Third-party official: Official |


### Examples

#### Demo

```tsx
import { getAccountInfo } from '@ray-js/ray'

getAccountInfo({
  success: data => {
    console.log(data);
  },
  fail: error => {
    console.error(error);
  },
});
```