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 (accountId)

The ID of the account to work with.

Example: F50091

query Parameters

personId	string <uuid> (personId) <= 36 characters The ID of the person to filter by. Example: personId=8e214819-5c83-429f-a976-eb127a0a8a88
include	Array of any Optional embeds to include when returning the account. Items Enum: "addresses" "currencies" "primaryOwner" "spot" "market" "settings" "maxCardsAndBudgets" "banks" "currencyAlignment" "productWithFeatures" Example: include=addresses,currencies,primaryOwner,spot,market,maxCardsAndBalances,productWithFeatures
originAccountId	string (accountId) The ID of the transfer origin account when considering for custom inbound fees. Example: originAccountId=F50091
destinationAccountId	string (accountId) The ID of the transfer destination account when considering for custom outbound fees. Example: destinationAccountId=F50091

Responses

200

400

Bad request

401

Unauthorised

403

Forbidden

404

Not found

405

Method not allowed

415

Unsupported media type

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": "customerClosed",
"termsAccepted": true,
"correlationId": "16700261790",
"primaryOwnerPersonaId": "28fe4bec-6e5a-475d-b118-1567f2fd5d25",
"privacyAccepted": true,
"salesperson": "Lester Spinka",
"accountManager": "Kerry McDermott",
"bankEntity": "BARC",
"currentRiskLevel": "Low",
"tier": "BRONZE",
"accountBanks": [{"id": "3ef24d53-6e22-4103-a16b-d268e4f7346d",
"accountId": "C12345",
"marketBank": {"name": "Barclays"
},
"marketBankId": "3ef24d53-6e22-4103-a16b-d268e4f7346d",
"priority": 1,
"type": "settlement"
}
],
"features": {"id": "fbc32687-acbf-4a8b-b60e-b93bb75878ca",
"accountId": "C12345",
"minimumCardOrderTopUpAmount": 50,
"minimumCardOrderTopUpAmountReached": true,
"payments": true,
"statementsFrom": "2021-01-30T08:30:00Z",
"cards": false,
"virtualCards": "inactive",
"physicalCards": "inactive",
"microCorp": null,
"sharedCardProductId": "fbc32687-acbf-4a8b-b60e-b93bb75878ca",
"individualVirtualCardProductId": "fbc32687-acbf-4a8b-b60e-b93bb75878ca",
"individualPhysicalCardProductId": "fbc32687-acbf-4a8b-b60e-b93bb75878ca",
"useBalanceName": false,
"forwardContracts": false,
"sourceOfBalance": "boxes",
"cardsSharedType": "prepaid",
"cardsIndividualType": "prepaid",
"selfApprove": false,
"apiIgnorePaymentApproval": false,
"moveMoneyRequests": false,
"subBalances": false,
"autoCreditToFundsHeld": false,
"dualAuthorise": false,
"freeInternalTransfers": false,
"createdAt": "2021-01-30T08:30:00Z",
"updatedAt": "2021-01-30T08:30:00Z"
},
"productId": "3ef24d53-6e22-4103-a16b-d268e4f7346d",
"primaryOwner": {"id": "288cf796-c1ad-4ffd-9eb9-af210bff0ea0",
"firstName": "Dolly",
"lastName": "Parton",
"title": "Mrs",
"middleInitials": "R",
"dob": "1946-01-19",
"gender": "Female",
"nationality": "US",
"countryOfResidence": "US",
"primaryMobileNumber": "+447798121212",
"primaryEmailAddress": "test@equalsqa.com",
"avatar": {"url": "string",
"fileName": "string"
},
"createdAt": "2021-01-30T08:30:00Z",
"updatedAt": "2021-01-30T08:30:00Z",
"sendInvite": true,
"roleId": "288cf796-c1ad-4ffd-9eb9-af210bff0ea0",
"verifyEmailAddress": true,
"verifyMobileNumber": true,
"sub": "288cf796-c1ad-4ffd-9eb9-af210bff0ea0",
"hasPeopleCard": true,
"card": {"id": "288cf796-c1ad-4ffd-9eb9-af210bff0ea0"
},
"persona": {"id": "96df2fd7-b2fa-4f0c-ba69-502246776f99",
"emailAddress": "Clint_Moore@gmail.com",
"employeeNumber": "948947464",
"workNumber": "(807) 940-7411 x8855",
"jobTitle": "Human Division Manager",
"status": "active",
"addresses": [{"id": "55ddc56e-f605-49c6-9862-0e8b55fa368f",
"type": "office",
"nickName": "office",
"addressLine1": "Great Building",
"addressLine2": "Four Maple Street",
"addressLine3": "Southwark",
"addressContact": "Brian May",
"city": "London",
"postcode": "SE13UB",
"country": "England",
"createdAt": "2021-01-30T08:30:00Z",
"updatedAt": "2021-01-30T08:30:00Z"
}
],
"createdBy": {"id": "288cf796-c1ad-4ffd-9eb9-af210bff0ea0",
"firstName": "Dolly",
"lastName": "Parton",
"title": "Mrs",
"middleInitials": "R",
"dob": "1946-01-19",
"gender": "Female",
"nationality": "US",
"countryOfResidence": "US",
"primaryMobileNumber": "+447798121212",
"primaryEmailAddress": "test@equalsqa.com",
"avatar": {"url": "string",
"fileName": "string"
},
"createdAt": "2021-01-30T08:30:00Z",
"updatedAt": "2021-01-30T08:30:00Z",
"sendInvite": true,
"roleId": "288cf796-c1ad-4ffd-9eb9-af210bff0ea0",
"verifyEmailAddress": true,
"verifyMobileNumber": true,
"sub": "288cf796-c1ad-4ffd-9eb9-af210bff0ea0",
"hasPeopleCard": true,
"card": {"id": "288cf796-c1ad-4ffd-9eb9-af210bff0ea0"
}
},
"primaryOwnerOf": {"id": "F50091",
"type": "Business",
"status": "customerClosed",
"termsAccepted": true,
"correlationId": "16700261790",
"privacyAccepted": true,
"salesperson": "Lester Spinka",
"accountManager": "Kerry McDermott",
"bankEntity": "BARC",
"currentRiskLevel": "Low",
"tier": "BRONZE",
"features": {"id": "fbc32687-acbf-4a8b-b60e-b93bb75878ca",
"accountId": "C12345",
"payments": true,
"cards": false,
"virtualCards": "inactive",
"physicalCards": "inactive",
"microCorp": null,
"sharedCardProductId": "fbc32687-acbf-4a8b-b60e-b93bb75878ca",
"individualVirtualCardProductId": "fbc32687-acbf-4a8b-b60e-b93bb75878ca",
"individualPhysicalCardProductId": "fbc32687-acbf-4a8b-b60e-b93bb75878ca",
"useBalanceName": false,
"forwardContracts": false,
"sourceOfBalance": "boxes",
"cardsSharedType": "prepaid",
"cardsIndividualType": "prepaid",
"selfApprove": false,
"apiIgnorePaymentApproval": false,
"moveMoneyRequests": false,
"subBalances": false,
"autoCreditToFundsHeld": false,
"dualAuthorise": false,
"freeInternalTransfers": false,
"createdAt": "2021-01-30T08:30:00Z",
"updatedAt": "2021-01-30T08:30:00Z"
},
"productId": "3ef24d53-6e22-4103-a16b-d268e4f7346d",
"primaryOwner": null,
"business": {"accountId": "C12345",
"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": "2021-01-30T08:30:00Z",
"updatedAt": "2021-01-30T08:30:00Z"
},
"personal": {"accountId": "C12345",
"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",
"createdAt": "2021-01-30T08:30:00Z",
"updatedAt": "2021-01-30T08:30:00Z"
},
"addresses": [{"id": "55ddc56e-f605-49c6-9862-0e8b55fa368f",
"type": "office",
"nickName": "office",
"addressLine1": "Great Building",
"addressLine2": "Four Maple Street",
"addressLine3": "Southwark",
"addressContact": "Brian May",
"city": "London",
"postcode": "SE13UB",
"country": "England",
"createdAt": "2021-01-30T08:30:00Z",
"updatedAt": "2021-01-30T08:30:00Z"
}
],
"currencies": [{"id": "af849178-b239-4661-9140-8ebe467d3541",
"code": "GBP",
"name": "Pound Sterling",
"status": {"enabled": true
}
}
],
"logo": {"url": "string",
"fileName": "string"
},
"payments": {"id": "28fe4bec-6e5a-475d-b118-1567f2fd5d25",
"active": true,
"maxLength": 42,
"depositRequired": 5,
"maxAmount": 500000,
"accountId": "C21209"
},
"solutions": true,
"createdAt": "2021-01-30T08:30:00Z",
"updatedAt": "2021-01-30T08:30:00Z",
"maxCardsAndBudgets": {"maxIndividualCards": 0,
"maxSharedCards": 0,
"maxBudgets": 0,
"maxIndividualCardsPerPerson": 0
},
"details": {"accountId": "C12345",
"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": "2021-01-30T08:30:00Z",
"updatedAt": "2021-01-30T08:30:00Z"
}
},
"teams": [{"id": "968d024b-0e86-45c0-85a1-9320800c1080",
"accountId": "F50091",
"name": "dolly@parton.com",
"description": "XYZ123",
"enabled": true,
"createdAt": "2021-01-30T08:30:00Z",
"updatedAt": "2021-01-30T08:30:00Z",
"personaCount": 1
}
],
"transactionalEmailPreference": true,
"cardTransactionPushNotificationPreference": false,
"inviteSentDate": "2018-12-01T14:54:30.000Z",
"createdAt": "2018-12-01T14:54:30.000Z",
"updatedAt": "2021-07-13T19:30:45.000Z",
"roles": [{"id": "fbc32687-acbf-4a8b-b60e-b93bb75878ca",
"accountId": "F50091",
"name": "Owner",
"type": "core",
"createdAt": "2021-09-01T14:19:16.000Z",
"updatedAt": "2021-09-01T14:19:16.000Z",
"permissions": [{"id": 321,
"permission": "cis:accounts:read",
"createdAt": "2021-09-01T14:19:16.000Z",
"updatedAt": "2021-09-01T14:19:16.000Z"
}
]
}
],
"balanceRoles": [{"id": "fbc32687-acbf-4a8b-b60e-b93bb75878ca",
"personaId": "8e214819-5c83-429f-a976-eb127a0a8a88",
"budgetId": "b489ea2c-0dd1-4fb1-b345-de5a596a5527",
"role": {"id": "fbc32687-acbf-4a8b-b60e-b93bb75878ca",
"name": "Balance Admin",
"type": "core",
"permissions": {"id": "fbc32687-acbf-4a8b-b60e-b93bb75878ca",
"budgetId": "b489ea2c-0dd1-4fb1-b345-de5a596a5527",
"permission": "cis:accounts:read",
"roleType": "balance"
}
}
}
],
"consolidatedPermissions": [{"id": "fbc32687-acbf-4a8b-b60e-b93bb75878ca",
"permission": "cis:accounts:read",
"roleType": "core"
}
]
}
},
"business": {"accountId": "C12345",
"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": "2021-01-30T08:30:00Z",
"updatedAt": "2021-01-30T08:30:00Z"
},
"personal": {"accountId": "C12345",
"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",
"createdAt": "2021-01-30T08:30:00Z",
"updatedAt": "2021-01-30T08:30:00Z"
},
"addresses": [{"id": "55ddc56e-f605-49c6-9862-0e8b55fa368f",
"type": "office",
"nickName": "office",
"addressLine1": "Great Building",
"addressLine2": "Four Maple Street",
"addressLine3": "Southwark",
"addressContact": "Brian May",
"city": "London",
"postcode": "SE13UB",
"country": "England",
"createdAt": "2021-01-30T08:30:00Z",
"updatedAt": "2021-01-30T08:30:00Z"
}
],
"currencies": [{"id": "af849178-b239-4661-9140-8ebe467d3541",
"code": "GBP",
"name": "Pound Sterling",
"status": {"enabled": true
}
}
],
"logo": {"url": "string",
"fileName": "string"
},
"payments": {"id": "28fe4bec-6e5a-475d-b118-1567f2fd5d25",
"active": true,
"maxLength": 42,
"depositRequired": 5,
"maxAmount": 500000,
"accountId": "C21209"
},
"solutions": true,
"createdAt": "2021-01-30T08:30:00Z",
"updatedAt": "2021-01-30T08:30:00Z",
"maxCardsAndBudgets": {"maxIndividualCards": 0,
"maxSharedCards": 0,
"maxBudgets": 0,
"maxIndividualCardsPerPerson": 0
},
"marketId": "77df854b-d069-4002-a643-a2fe61a3b100",
"market": {"id": "77df854b-d069-4002-a643-a2fe61a3b100",
"name": "UK",
"baseCurrencyId": "77df854b-d069-4002-a643-a2fe61a3b101",
"createdAt": "2022-09-27T08:30:00Z",
"updatedAt": "2022-09-27T08:30:00Z"
}
}