Organization
Get Organization Details
- Documentation
- SEPA's API
- API Explore
- Community
- Welcome to FinHub
- GETGet document
- GETGet documents
- GETGet verification result
- POSTPost document upload
- PUTPut document status
- PUTPut document update
- GETGet card balance
- GETGet card pin
- GETGet card product config
- GETGet card product list
- GETGet card product
- GETGet card transactions
- GETGet card usage
- GETGet card
- GETGet cardholder
- GETGet EHIMode configuration
- GETGet issuer
- POSTPost card credit
- POSTPost card debit
- POSTPost card product setup
- POSTPost card product
- POSTPost card transfers
- POSTPost card usage
- POSTPost card
- POSTPost cardholder
- POSTPost EHIMode configuration
- POSTPost issuer
- PUTPut card account
- PUTPut card activate
- PUTPut card cardholder
- PUTPut card lost
- PUTPut card pin
- PUTPut card product config
- PUTPut card stolen
- PUTPut card suspend
- PUTPut cardholder
- PUTPut EHIMode configuration
- PUTPut issuer
- Private
- Public
- 2FA
- AccessControl
- Active Session
- Credentials
- Customer
- Organization
- PATCHCreate business address
- POSTCreate business customer documents
- POSTCreate Organization Bulk
- POSTCreate Organization by Customer Type
- POSTCreate Organization
- DELDelete organization entity
- DELDelete organization shareholder delete
- POSTGet Organization By Business Type
- POSTGet Organization By Customer Type
- GETGet Organization Details
- GETGet organization documents by purpose
- GETGet organization documents
- GETGet organization entity
- GETGet organization get address
- GETGet organization get by id
- GETGet organization get customers
- GETGet organization shareholder get
- PATCHPatch organization entity create
- PATCHPatch organization entity update
- PATCHPatch organization shareholder create
- PATCHPatch organization shareholder update
- POSTPost organization get all
- PUTPut organization update kyb status
- PUTPut organization update status
- PUTUpdate Organization
- PATCH
- POSTPost send
- POSTGenerateToken
- IPG Backoffice APIs
- IPG Payment APIs
- Company
- EIN Verification
- IBAN Verification
- NIF Verification
- Product
- System
- TIN Verification
- VAT Verification
- POSTPost authorize
- POSTPost backgroundcheck
- POSTPost delete info
- POSTPost face
- POSTPost get info
- POSTPost scan documents
- POSTPost upload image
- PUTPut backgroundcheck
- Global Settings
- Rules
- Smart Contract
- Admin
- Allowed Operation
- Assets
- Currency
- Currency Pairs
- Dashboard
- Fee
- Limit
- Misc
- Operation Address
- Operation Destination
- Order
- Transactions
- Wallets
Introduction
AML
CMS
Crypto
Customer
muse-openapi
IPG
KYB
KYC
Smart Contract
Wallet
Organization
Get Organization Details
GET
/
organization
/
getDetails
/
{organizationId}
Authorization
string
*
Bearer
Authorization
Required
string
The access token received from the authorization server in the OAuth 2.0 flow.
tenantId
string
*
tenantId
Required
string
Tenant/Owner id
organizationId
string
*
organizationId
Required
string
Organization id
Authorizations
Authorization
string
headerrequiredThe access token received from the authorization server in the OAuth 2.0 flow.
Headers
tenantId
string
requiredTenant/Owner id
Path Parameters
organizationId
string
requiredOrganization id
Response
200 - application/json
tenantId
string
organization
object
organization.countryOfCorporation
string
organization.legalName
string
organization.isTradingNameExist
boolean
default: falseorganization.tradingName
string
organization.taxRegistrationNumber
string
organization.taxIdentificationNumber
string
organization.dateOfIncorporation
string
organization.businesstypes
string
organization.sourceOfIncomingFund
string
organization.purposeOfAccount
string
organization.expectedAnnualActivityOfPlatform
string
organization.registrationNumber
string
organization.businessType
enum<string>
Available options:
Partner, Supplier organization.shareholders
object[]
organization.shareholders.id
string
organization.shareholders.personFullname
string
organization.shareholders.peerFullname
string
organization.shareholders.escliationFullname
string
organization.shareholders.status
string
organization.shareholders.responsibility
string
organization.shareholders.positions
string
organization.shareholders.ownershipPercentage
string
organization.shareholders.person
object
organization.shareholders.person.firstName
object
organization.shareholders.person.firstName.name
string
organization.shareholders.person.firstName.order
integer
organization.shareholders.person.firstName.abbreviation
string
organization.shareholders.person.firstName.language
string
organization.shareholders.person.firstName.native
string
organization.shareholders.person.firstName.suffix
string
organization.shareholders.person.firstName.prefix
string
organization.shareholders.person.lastName
object
organization.shareholders.person.lastName.name
string
organization.shareholders.person.lastName.order
integer
organization.shareholders.person.lastName.abbreviation
string
organization.shareholders.person.lastName.language
string
organization.shareholders.person.lastName.native
string
organization.shareholders.person.lastName.suffix
string
organization.shareholders.person.lastName.prefix
string
organization.shareholders.person.fullName
string
organization.shareholders.person.groupId
string
organization.shareholders.person.gender
enum<string>
Available options:
Male, Female, Non-binary, Transgender, Other, Prefer not to tell organization.shareholders.person.dateOfBirth
string
organization.shareholders.person.placeOfBirth
string
organization.shareholders.person.nationality
string
organization.shareholders.person.pinCode
string
organization.shareholders.person.password
string
organization.shareholders.person.email
string
organization.shareholders.person.telephoneNumbers
object[]
organization.shareholders.person.telephoneNumbers.phoneType
enum<string>
Available options:
fixed, mobile, satellite, virtual organization.shareholders.person.telephoneNumbers.operator
string
organization.shareholders.person.telephoneNumbers.encoding
enum<string>
Available options:
numbers, international, text organization.shareholders.person.telephoneNumbers.country
string
organization.shareholders.person.telephoneNumbers.number
string
organization.shareholders.person.telephoneNumbers.purpose
string
organization.shareholders.person.addresses
object[]
organization.shareholders.person.addresses.addressPurpose
string
organization.shareholders.person.addresses.address
object
organization.shareholders.person.addresses.address.country
string
organization.shareholders.person.addresses.address.area
string
organization.shareholders.person.addresses.address.zipCode
string
organization.shareholders.person.addresses.address.city
string
organization.shareholders.person.addresses.address.street
string
organization.shareholders.person.addresses.address.streetNumber
string[]
organization.shareholders.person.addresses.address.building
string
organization.shareholders.person.addresses.address.apartment
string
organization.shareholders.person.addresses.address.entrance
string
organization.shareholders.person.addresses.address.floor
string
organization.shareholders.person.addresses.address.doorNumber
string
organization.shareholders.person.addresses.address.geoPosition
object
organization.shareholders.person.addresses.address.geoPosition.latitude
number
organization.shareholders.person.addresses.address.geoPosition.longitude
number
organization.shareholders.person.addresses.address.geoPosition.altitude
number
organization.shareholders.person.addresses.address.alternative
object
organization.shareholders.person.addresses.address.alternative.word1
string
organization.shareholders.person.addresses.address.alternative.word2
string
organization.shareholders.person.addresses.address.alternative.word3
string
organization.shareholders.person.addresses.address.relatedToAddress
object[]
organization.shareholders.person.addresses.address.relatedToAddress.relationType
enum<string>
Available options:
near_by, crossing, opposite_to, inside_of, behind, infront organization.shareholders.person.addresses.address.relatedToAddress.address
string
organization.shareholders.person.addresses.address.additionalData
object[]
organization.shareholders.person.addresses.address.additionalData.name
string
organization.shareholders.person.addresses.address.additionalData.type
enum<string>
Available options:
Number, Boolean, json, string organization.shareholders.person.addresses.address.additionalData.value
string
organization.shareholders.person.documents
object[]
organization.shareholders.person.documents.purpose
enum<string>
Available options:
KYB, KYC, PEP&SANCTION organization.shareholders.person.documents.name
string
organization.shareholders.person.documents.documentType
enum<string>
Available options:
ID front side, ID back side, Passport, accountAuthority, shareholderStructure, operationAddress, registeredAddress, selfie, livelinessDetection organization.shareholders.person.documents.location
string
organization.shareholders.person.documents.verificationResponse
string
organization.shareholders.person.documents.status
enum<string>
Available options:
underverification, verified, declined, incomplete, expired organization.shareholders.person.documents.metadata
object[]
organization.shareholders.person.documents.metadata.name
string
organization.shareholders.person.documents.metadata.type
enum<string>
Available options:
Number, Boolean, json, string organization.shareholders.person.documents.metadata.value
string
organization.shareholders.person.SecretQuestion
object[]
organization.shareholders.person.SecretQuestion.question
string
organization.shareholders.person.SecretQuestion.answer
string
organization.shareholders.escallation
object
organization.shareholders.escallation.firstName
object
organization.shareholders.escallation.firstName.name
string
organization.shareholders.escallation.firstName.order
integer
organization.shareholders.escallation.firstName.abbreviation
string
organization.shareholders.escallation.firstName.language
string
organization.shareholders.escallation.firstName.native
string
organization.shareholders.escallation.firstName.suffix
string
organization.shareholders.escallation.firstName.prefix
string
organization.shareholders.escallation.lastName
object
organization.shareholders.escallation.lastName.name
string
organization.shareholders.escallation.lastName.order
integer
organization.shareholders.escallation.lastName.abbreviation
string
organization.shareholders.escallation.lastName.language
string
organization.shareholders.escallation.lastName.native
string
organization.shareholders.escallation.lastName.suffix
string
organization.shareholders.escallation.lastName.prefix
string
organization.shareholders.escallation.fullName
string
organization.shareholders.escallation.groupId
string
organization.shareholders.escallation.gender
enum<string>
Available options:
Male, Female, Non-binary, Transgender, Other, Prefer not to tell organization.shareholders.escallation.dateOfBirth
string
organization.shareholders.escallation.placeOfBirth
string
organization.shareholders.escallation.nationality
string
organization.shareholders.escallation.pinCode
string
organization.shareholders.escallation.password
string
organization.shareholders.escallation.email
string
organization.shareholders.escallation.telephoneNumbers
object[]
organization.shareholders.escallation.telephoneNumbers.phoneType
enum<string>
Available options:
fixed, mobile, satellite, virtual organization.shareholders.escallation.telephoneNumbers.operator
string
organization.shareholders.escallation.telephoneNumbers.encoding
enum<string>
Available options:
numbers, international, text organization.shareholders.escallation.telephoneNumbers.country
string
organization.shareholders.escallation.telephoneNumbers.number
string
organization.shareholders.escallation.telephoneNumbers.purpose
string
organization.shareholders.escallation.addresses
object[]
organization.shareholders.escallation.addresses.addressPurpose
string
organization.shareholders.escallation.addresses.address
object
organization.shareholders.escallation.addresses.address.country
string
organization.shareholders.escallation.addresses.address.area
string
organization.shareholders.escallation.addresses.address.zipCode
string
organization.shareholders.escallation.addresses.address.city
string
organization.shareholders.escallation.addresses.address.street
string
organization.shareholders.escallation.addresses.address.streetNumber
string[]
organization.shareholders.escallation.addresses.address.building
string
organization.shareholders.escallation.addresses.address.apartment
string
organization.shareholders.escallation.addresses.address.entrance
string
organization.shareholders.escallation.addresses.address.floor
string
organization.shareholders.escallation.addresses.address.doorNumber
string
organization.shareholders.escallation.addresses.address.geoPosition
object
organization.shareholders.escallation.addresses.address.geoPosition.latitude
number
organization.shareholders.escallation.addresses.address.geoPosition.longitude
number
organization.shareholders.escallation.addresses.address.geoPosition.altitude
number
organization.shareholders.escallation.addresses.address.alternative
object
organization.shareholders.escallation.addresses.address.alternative.word1
string
organization.shareholders.escallation.addresses.address.alternative.word2
string
organization.shareholders.escallation.addresses.address.alternative.word3
string
organization.shareholders.escallation.addresses.address.relatedToAddress
object[]
organization.shareholders.escallation.addresses.address.relatedToAddress.relationType
enum<string>
Available options:
near_by, crossing, opposite_to, inside_of, behind, infront organization.shareholders.escallation.addresses.address.relatedToAddress.address
string
organization.shareholders.escallation.addresses.address.additionalData
object[]
organization.shareholders.escallation.addresses.address.additionalData.name
string
organization.shareholders.escallation.addresses.address.additionalData.type
enum<string>
Available options:
Number, Boolean, json, string organization.shareholders.escallation.addresses.address.additionalData.value
string
organization.shareholders.escallation.documents
object[]
organization.shareholders.escallation.documents.purpose
enum<string>
Available options:
KYB, KYC, PEP&SANCTION organization.shareholders.escallation.documents.name
string
organization.shareholders.escallation.documents.documentType
enum<string>
Available options:
ID front side, ID back side, Passport, accountAuthority, shareholderStructure, operationAddress, registeredAddress, selfie, livelinessDetection organization.shareholders.escallation.documents.location
string
organization.shareholders.escallation.documents.verificationResponse
string
organization.shareholders.escallation.documents.status
enum<string>
Available options:
underverification, verified, declined, incomplete, expired organization.shareholders.escallation.documents.metadata
object[]
organization.shareholders.escallation.documents.metadata.name
string
organization.shareholders.escallation.documents.metadata.type
enum<string>
Available options:
Number, Boolean, json, string organization.shareholders.escallation.documents.metadata.value
string
organization.shareholders.escallation.SecretQuestion
object[]
organization.shareholders.escallation.SecretQuestion.question
string
organization.shareholders.escallation.SecretQuestion.answer
string
organization.shareholders.peers
object
organization.shareholders.peers.firstName
object
organization.shareholders.peers.firstName.name
string
organization.shareholders.peers.firstName.order
integer
organization.shareholders.peers.firstName.abbreviation
string
organization.shareholders.peers.firstName.language
string
organization.shareholders.peers.firstName.native
string
organization.shareholders.peers.firstName.suffix
string
organization.shareholders.peers.firstName.prefix
string
organization.shareholders.peers.lastName
object
organization.shareholders.peers.lastName.name
string
organization.shareholders.peers.lastName.order
integer
organization.shareholders.peers.lastName.abbreviation
string
organization.shareholders.peers.lastName.language
string
organization.shareholders.peers.lastName.native
string
organization.shareholders.peers.lastName.suffix
string
organization.shareholders.peers.lastName.prefix
string
organization.shareholders.peers.fullName
string
organization.shareholders.peers.groupId
string
organization.shareholders.peers.gender
enum<string>
Available options:
Male, Female, Non-binary, Transgender, Other, Prefer not to tell organization.shareholders.peers.dateOfBirth
string
organization.shareholders.peers.placeOfBirth
string
organization.shareholders.peers.nationality
string
organization.shareholders.peers.pinCode
string
organization.shareholders.peers.password
string
organization.shareholders.peers.email
string
organization.shareholders.peers.telephoneNumbers
object[]
organization.shareholders.peers.telephoneNumbers.phoneType
enum<string>
Available options:
fixed, mobile, satellite, virtual organization.shareholders.peers.telephoneNumbers.operator
string
organization.shareholders.peers.telephoneNumbers.encoding
enum<string>
Available options:
numbers, international, text organization.shareholders.peers.telephoneNumbers.country
string
organization.shareholders.peers.telephoneNumbers.number
string
organization.shareholders.peers.telephoneNumbers.purpose
string
organization.shareholders.peers.addresses
object[]
organization.shareholders.peers.addresses.addressPurpose
string
organization.shareholders.peers.addresses.address
object
organization.shareholders.peers.addresses.address.country
string
organization.shareholders.peers.addresses.address.area
string
organization.shareholders.peers.addresses.address.zipCode
string
organization.shareholders.peers.addresses.address.city
string
organization.shareholders.peers.addresses.address.street
string
organization.shareholders.peers.addresses.address.streetNumber
string[]
organization.shareholders.peers.addresses.address.building
string
organization.shareholders.peers.addresses.address.apartment
string
organization.shareholders.peers.addresses.address.entrance
string
organization.shareholders.peers.addresses.address.floor
string
organization.shareholders.peers.addresses.address.doorNumber
string
organization.shareholders.peers.addresses.address.geoPosition
object
organization.shareholders.peers.addresses.address.geoPosition.latitude
number
organization.shareholders.peers.addresses.address.geoPosition.longitude
number
organization.shareholders.peers.addresses.address.geoPosition.altitude
number
organization.shareholders.peers.addresses.address.alternative
object
organization.shareholders.peers.addresses.address.alternative.word1
string
organization.shareholders.peers.addresses.address.alternative.word2
string
organization.shareholders.peers.addresses.address.alternative.word3
string
organization.shareholders.peers.addresses.address.relatedToAddress
object[]
organization.shareholders.peers.addresses.address.relatedToAddress.relationType
enum<string>
Available options:
near_by, crossing, opposite_to, inside_of, behind, infront organization.shareholders.peers.addresses.address.relatedToAddress.address
string
organization.shareholders.peers.addresses.address.additionalData
object[]
organization.shareholders.peers.addresses.address.additionalData.name
string
organization.shareholders.peers.addresses.address.additionalData.type
enum<string>
Available options:
Number, Boolean, json, string organization.shareholders.peers.addresses.address.additionalData.value
string
organization.shareholders.peers.documents
object[]
organization.shareholders.peers.documents.purpose
enum<string>
Available options:
KYB, KYC, PEP&SANCTION organization.shareholders.peers.documents.name
string
organization.shareholders.peers.documents.documentType
enum<string>
Available options:
ID front side, ID back side, Passport, accountAuthority, shareholderStructure, operationAddress, registeredAddress, selfie, livelinessDetection organization.shareholders.peers.documents.location
string
organization.shareholders.peers.documents.verificationResponse
string
organization.shareholders.peers.documents.status
enum<string>
Available options:
underverification, verified, declined, incomplete, expired organization.shareholders.peers.documents.metadata
object[]
organization.shareholders.peers.documents.metadata.name
string
organization.shareholders.peers.documents.metadata.type
enum<string>
Available options:
Number, Boolean, json, string organization.shareholders.peers.documents.metadata.value
string
organization.shareholders.peers.SecretQuestion
object[]
organization.shareholders.peers.SecretQuestion.question
string
organization.shareholders.peers.SecretQuestion.answer
string
organization.relatedTo
object
organization.relatedTo.relationType
string
organization.relatedTo.organizationID
string
organization.website
string
organization.businessSector
string
organization.rangeOfServicesOrGoods
string
organization.transactionPredict
object
organization.transactionPredict.MonthlyVolumeRange
number
organization.transactionPredict.NumberOfMonthlyPayment
number
organization.transactionPredict.MaxSinglePayment
number
organization.countryList
object
organization.countryList.SendList
string[]
organization.countryList.ReceiveList
string[]
organization.telephoneNumber
object[]
organization.telephoneNumber.phoneType
enum<string>
Available options:
fixed, mobile, satellite, virtual organization.telephoneNumber.operator
string
organization.telephoneNumber.encoding
enum<string>
Available options:
numbers, international, text organization.telephoneNumber.country
string
organization.telephoneNumber.number
string
organization.telephoneNumber.purpose
string
organization.addresses
object[]
organization.addresses.addressPurpose
string
organization.addresses.address
object
organization.addresses.address.country
string
organization.addresses.address.area
string
organization.addresses.address.zipCode
string
organization.addresses.address.city
string
organization.addresses.address.street
string
organization.addresses.address.streetNumber
string[]
organization.addresses.address.building
string
organization.addresses.address.apartment
string
organization.addresses.address.entrance
string
organization.addresses.address.floor
string
organization.addresses.address.doorNumber
string
organization.addresses.address.geoPosition
object
organization.addresses.address.geoPosition.latitude
number
organization.addresses.address.geoPosition.longitude
number
organization.addresses.address.geoPosition.altitude
number
organization.addresses.address.alternative
object
organization.addresses.address.alternative.word1
string
organization.addresses.address.alternative.word2
string
organization.addresses.address.alternative.word3
string
organization.addresses.address.relatedToAddress
object[]
organization.addresses.address.relatedToAddress.relationType
enum<string>
Available options:
near_by, crossing, opposite_to, inside_of, behind, infront organization.addresses.address.relatedToAddress.address
string
organization.addresses.address.additionalData
object[]
organization.addresses.address.additionalData.name
string
organization.addresses.address.additionalData.type
enum<string>
Available options:
Number, Boolean, json, string organization.addresses.address.additionalData.value
string
organization.documents
object[]
organization.documents.purpose
enum<string>
Available options:
KYB, KYC, PEP&SANCTION organization.documents.name
string
organization.documents.documentType
enum<string>
Available options:
ID front side, ID back side, Passport, accountAuthority, shareholderStructure, operationAddress, registeredAddress, selfie, livelinessDetection organization.documents.location
string
organization.documents.verificationResponse
string
organization.documents.status
enum<string>
Available options:
underverification, verified, declined, incomplete, expired organization.documents.metadata
object[]
organization.documents.metadata.name
string
organization.documents.metadata.type
enum<string>
Available options:
Number, Boolean, json, string organization.documents.metadata.value
string
organization.businessToBusinessMap
object[]
organization.businessToBusinessMap.relationType
enum<string>
Available options:
Partner, Supplier organization.businessToBusinessMap.tenannaId
string
organization.businessToBusinessMap.organizationId
string
organization.businessToBusinessMap.RelatingorganizationId
string
organization.businessToCustomerMap
object[]
organization.businessToCustomerMap.relationType
enum<string>
Available options:
Employee, Shareholder, Customer organization.businessToCustomerMap.tenannaId
string
organization.businessToCustomerMap.personid
string
organization.businessToCustomerMap.organizationId
string