Retrieve an account's details

Returns data for a given accountId. The response will contain either personal or business details, such as account name, primary owner of the account, and enabled features.

SecurityCommonAuth

Request

path Parameters

accountId

required

string

The ID of the account to work with.

Example: F50091

query Parameters

personId	string <uuid> <= 36 characters The ID of the person to work with. Example: personId=775596ae-2624-40af-a9dc-9756110a4a04
include	string The type of embed to include. Comma separated list, url encoded. Enum: "addresses" "currencies" "primaryOwner" "market" "settings" "maxCardsAndBudgets" "banks" "currencyAlignment" "productWithFeatures" Example: include=currencies,market

Responses

200

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

405

Method Not Allowed

415

Unsupported Media Type

422

Unable to process the request

429

Too Many Requests

500

Internal Server Error

get/accounts/{accountId}

Request samples

curl
JavaScript
Node.js

Response samples

application/json

{"id": "F50091",
"type": "Business",
"status": "applicationPending",
"termsAccepted": true,
"correlationId": "16700261790",
"privacyAccepted": true,
"salesperson": "Lester Spinka",
"accountManager": "Kerry McDermott",
"bankEntity": "BARC",
"currentRiskLevel": "Low",
"tier": "BRONZE",
"features": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"accountId": "F50091",
"payments": true,
"batchPayments": true,
"cards": true,
"virtualCards": "active",
"physicalCards": "active",
"microCorp": true,
"sharedCardProductId": "554bab88-15af-49ca-bd53-d0bd3aeab002",
"individualVirtualCardProductId": "78da7405-b96f-4404-8bdc-b2af36413bed",
"individualPhysicalCardProductId": "d92913b7-2f88-490c-84d3-4293ec0b3472",
"useBalanceName": true,
"forwardContracts": true,
"sourceOfBalance": "boxes",
"cardsSharedType": "prepaid",
"cardsIndividualType": "prepaid",
"selfApprove": true,
"apiIgnorePaymentApproval": true,
"moveMoneyRequests": true,
"subBalances": true,
"autoCreditToFundsHeld": true,
"dualAuthorise": true,
"freeInternalTransfers": true,
"expediteCardProcessingEnabled": true,
"enforceMFAVerification": false,
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
},
"productId": "3ef24d53-6e22-4103-a16b-d268e4f7346d",
"primaryOwner": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"firstName": "Dolly",
"lastName": "Parton",
"title": "Master",
"middleInitials": "R",
"dob": "1946-01-19",
"gender": "Female",
"nationality": "US",
"countryOfResidence": "US",
"primaryMobileNumber": "+447798121212",
"primaryEmailAddress": "test@equalsqa.com",
"avatar": {"url": "string",
"fileName": "string"
},
"sendInvite": true,
"roleId": "7382d58e-652a-4905-b7c9-bcca1e0e5391",
"verifyEmailAddress": true,
"verifyMobileNumber": true,
"sub": "753487e7-10bc-4e69-b3b2-4da33721ea3e",
"hasPeopleCard": true,
"card": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"persona": { },
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
},
"business": {"accountId": "F50091",
"name": "FairFX",
"countryOfRegistration": "United Kingdom",
"companyType": "Limited",
"companiesHouseId": "05539698",
"telephoneNumber": "020 122 123",
"timezone": "Europe/London",
"registeredName": "FairFX",
"tradingName": "FairFX Group",
"website": "https://fairfx.com",
"industry": "Financial Services",
"fourthLine": "FairFX",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
},
"personal": {"accountId": "F50091",
"name": "FairFX",
"countryOfRegistration": "United Kingdom",
"companyType": "companyType",
"companiesHouseId": "05539698",
"telephoneNumber": "020 122 123",
"timezone": "Europe/London",
"registeredName": "FairFX",
"tradingName": "FairFX Group",
"website": "https://fairfx.com",
"industry": "Financial Services",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
},
"addresses": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"type": "office",
"nickName": "office",
"addressLine1": "Great Building",
"addressLine2": "Four Maple Street",
"addressLine3": "Southwark",
"addressContact": "Brian May",
"city": "string",
"postcode": "SE13UB",
"country": "England",
"countryCode": "GB",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}
],
"currencies": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"code": "GBP",
"name": "Pound Sterling",
"status": {"enabled": true
}
}
],
"logo": {"url": "string",
"fileName": "string"
},
"payments": {"id": "string",
"active": true,
"maxLength": 42,
"depositRequired": 5,
"maxAmount": 500000,
"accountId": "F50091"
},
"solutions": true,
"maxCardsAndBudgets": {"maxIndividualCards": 0,
"maxSharedCards": 0,
"maxBudgets": 0,
"maxIndividualCardsPerPerson": 0
},
"details": {"accountId": "F50091",
"name": "FairFX",
"countryOfRegistration": "United Kingdom",
"companyType": "Limited",
"companiesHouseId": "05539698",
"telephoneNumber": "020 122 123",
"timezone": "Europe/London",
"registeredName": "FairFX",
"tradingName": "FairFX Group",
"website": "https://fairfx.com",
"industry": "Financial Services",
"fourthLine": "FairFX",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
},
"marketId": "3ef24d53-6e22-4103-a16b-d268e4f7346d",
"market": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "UK",
"bank": "string",
"baseCurrencyId": "7188015d-0ba6-4f9a-a255-5c3b5aa06eca",
"atmWithdrawalFee": 0,
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
},
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"primaryOwnerPersonaId": "7734d652-76e5-4d92-a9d4-f83c69a2caa3",
"currencyAlignment": true,
"accountBanks": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"accountId": "F50091",
"marketBank": {"name": "Barclays"
},
"marketBankId": "b1065e35-4037-4a43-b497-2a449857cb42",
"priority": 1,
"type": "settlement"
}
]
}