Skip to main content
GET
/
accounts
/
{clientId}
Verify Account
curl --request GET \
  --url https://api.fyatu.com/api/v3/accounts/{clientId} \
  --header 'Authorization: Bearer <token>'
{
  "success": true,
  "status": 200,
  "message": "Account verified successfully",
  "data": {
    "clientId": "F12345678",
    "name": "John Doe",
    "isActive": true,
    "canReceive": true
  },
  "meta": {
    "requestId": "req_abc123",
    "timestamp": "2026-01-08T10:30:00+00:00"
  }
}

Overview

Verify a Fyatu account before making a payout. This confirms the account exists, is active, and can receive funds.
Always verify the recipient account before making a payout to prevent failed transactions and lost funds.

Path Parameters

ParameterTypeDescription
clientIdstringThe recipient’s Fyatu client ID

Response

FieldTypeDescription
clientIdstringVerified client ID
namestringAccount holder’s name
accountTypestringAccount type (PERSONAL, BUSINESS)
statusstringAccount status
kycVerifiedbooleanWhether account is KYC verified
canReceivebooleanWhether account can receive payouts

Example Usage

<?php
$clientId = 'F12345678';

$response = file_get_contents(
    "https://api.fyatu.com/api/v3/accounts/{$clientId}",
    false,
    stream_context_create([
        'http' => [
            'method' => 'GET',
            'header' => 'Authorization: Bearer ' . $accessToken
        ]
    ])
);

$result = json_decode($response, true);

if ($result['success']) {
    $account = $result['data'];

    if (!$account['canReceive']) {
        echo "Account cannot receive payouts: Status is {$account['status']}\n";
        exit;
    }

    // Show confirmation to user
    echo "Recipient: {$account['name']}\n";
    echo "Account Type: {$account['accountType']}\n";
    echo "KYC Verified: " . ($account['kycVerified'] ? 'Yes' : 'No') . "\n";

    // Proceed with payout...
} else {
    echo "Account not found\n";
}

Example Response

{
  "success": true,
  "status": 200,
  "message": "Account verified successfully",
  "data": {
    "clientId": "F12345678",
    "name": "John Doe",
    "accountType": "PERSONAL",
    "status": "ACTIVE",
    "kycVerified": true,
    "canReceive": true
  },
  "meta": {
    "requestId": "req_verify123",
    "timestamp": "2026-01-08T10:00:00+00:00"
  }
}

Status Values

StatuscanReceiveDescription
ACTIVEtrueAccount is active and can receive
INACTIVEfalseAccount is inactive
SUSPENDEDfalseAccount is suspended
DELETEDfalseAccount is deleted

Best Practices

  1. Always Verify First: Verify the account before showing payout confirmation to user
  2. Display Name: Show the recipient’s name for user confirmation
  3. Check canReceive: Only proceed if canReceive is true
  4. Handle Not Found: Account may have been deleted or never existed
For better UX, verify the account as the user types and show the recipient’s name before they confirm the payout.

Error Responses

Error CodeHTTPDescription
RESOURCE_NOT_FOUND404Account not found
AUTH_TOKEN_INVALID401Invalid or expired token

Authorizations

Authorization
string
header
required

JWT access token obtained from /auth/token

Path Parameters

clientId
string
required

Recipient's Fyatu client ID

Example:

"F12345678"

Response

Account verified successfully

success
boolean
Example:

true

status
integer
Example:

200

message
string
data
object
meta
object