DokumentationEngagement Platform API
Sign inGet started
Guides
API

Profile

GET
/organizations/{organizationId}/profile
Get business profile
Antwort-Payload
addressInformation
object
Untergeordnete Attribute anzeigen
addressInformation.billingAddress
object
Untergeordnete Attribute anzeigen
addressInformation.billingAddress.addressType
string
addressInformation.billingAddress.city
string
addressInformation.billingAddress.countryCode
string
The ISO-3166-1 Alpha-2 code for the country.
addressInformation.billingAddress.postalCode
string
addressInformation.billingAddress.state
string
addressInformation.billingAddress.streetName
string
addressInformation.billingAddress.streetNumber
string
addressInformation.mailingAddress
object
Untergeordnete Attribute anzeigen
addressInformation.mailingAddress.addressType
string
addressInformation.mailingAddress.city
string
addressInformation.mailingAddress.countryCode
string
The ISO-3166-1 Alpha-2 code for the country.
addressInformation.mailingAddress.postalCode
string
addressInformation.mailingAddress.state
string
addressInformation.mailingAddress.streetName
string
addressInformation.mailingAddress.streetNumber
string
addressInformation.operatingAddress
object
Untergeordnete Attribute anzeigen
addressInformation.operatingAddress.addressType
string
addressInformation.operatingAddress.city
string
addressInformation.operatingAddress.countryCode
string
The ISO-3166-1 Alpha-2 code for the country.
addressInformation.operatingAddress.postalCode
string
addressInformation.operatingAddress.state
string
addressInformation.operatingAddress.streetName
string
addressInformation.operatingAddress.streetNumber
string
addressInformation.registeredAddress
object
Untergeordnete Attribute anzeigen
addressInformation.registeredAddress.addressType
string
addressInformation.registeredAddress.city
string
addressInformation.registeredAddress.countryCode
string
The ISO-3166-1 Alpha-2 code for the country.
addressInformation.registeredAddress.postalCode
string
addressInformation.registeredAddress.state
string
addressInformation.registeredAddress.streetName
string
addressInformation.registeredAddress.streetNumber
string
businessDetails
object
Untergeordnete Attribute anzeigen
businessDetails.annualRevenue
integer
businessDetails.businessDescription
string
businessDetails.businessStartDate
string
businessDetails.currency
string
businessDetails.duns
string
businessDetails.entityType
string
businessDetails.giin
string
businessDetails.goodsOrServicesDescription
string
businessDetails.incorporationJurisdiction
string
businessDetails.industryGroup
string
businessDetails.lei
string
businessDetails.numberOfEmployees
integer
businessDetails.operatingCountries
array of string
businessDetails.publiclyListed
boolean
businessDetails.registrationNumber
string
businessDetails.stockExchange
string
businessDetails.taxIdentificationNumber
string
businessDetails.tickerSymbol
string
businessDetails.type
string
The business type.
Possible values: unknown, public, private, personal, education, government, nonprofit
businessDetails.vatNumber
string
businessDetails.vatNumberStatus
string
Possible values: none, pending, valid, invalid
contactInformation
object
Untergeordnete Attribute anzeigen
contactInformation.invoicingEmail
string
contactInformation.primaryEmail
string
contactInformation.primaryPhone
string
contactInformation.secondaryPhone
string
contactInformation.website
string
documents
array of object
Untergeordnete Attribute anzeigen
documents.documentType
string
Type of the document
documents.fileUrls
array of string
List of URLs where the document can be accessed
domain
string
Domain name.
id
string
The profile ID
legalName
string
The name under which this business is registered.
logoUrl
string
name
string
The name under which this business is commonly referred to.
significantContacts
object
Untergeordnete Attribute anzeigen
significantContacts.contacts
array of object
Organization's significant contacts.
Untergeordnete Attribute anzeigen
significantContacts.contacts.contactCategories
array of string
significantContacts.contacts.email
string
significantContacts.contacts.name
string
significantContacts.contacts.phone
string
significantContacts.predefinedContactCategories
array of string
socialMedia
array of object
Untergeordnete Attribute anzeigen
socialMedia.handle
string
The name or handle used on the platform
socialMedia.platform
string
The social media platform
ultimateBeneficialOwners
array of object
Untergeordnete Attribute anzeigen
ultimateBeneficialOwners.addressInformation
object
Untergeordnete Attribute anzeigen
ultimateBeneficialOwners.addressInformation.mailingAddress
object
Untergeordnete Attribute anzeigen
ultimateBeneficialOwners.addressInformation.mailingAddress.addressType
string
ultimateBeneficialOwners.addressInformation.mailingAddress.city
string
ultimateBeneficialOwners.addressInformation.mailingAddress.countryCode
string
The ISO-3166-1 Alpha-2 code for the country.
ultimateBeneficialOwners.addressInformation.mailingAddress.postalCode
string
ultimateBeneficialOwners.addressInformation.mailingAddress.state
string
ultimateBeneficialOwners.addressInformation.mailingAddress.streetName
string
ultimateBeneficialOwners.addressInformation.mailingAddress.streetNumber
string
ultimateBeneficialOwners.addressInformation.residentialAddress
object
Untergeordnete Attribute anzeigen
ultimateBeneficialOwners.addressInformation.residentialAddress.addressType
string
ultimateBeneficialOwners.addressInformation.residentialAddress.city
string
ultimateBeneficialOwners.addressInformation.residentialAddress.countryCode
string
The ISO-3166-1 Alpha-2 code for the country.
ultimateBeneficialOwners.addressInformation.residentialAddress.postalCode
string
ultimateBeneficialOwners.addressInformation.residentialAddress.state
string
ultimateBeneficialOwners.addressInformation.residentialAddress.streetName
string
ultimateBeneficialOwners.addressInformation.residentialAddress.streetNumber
string
ultimateBeneficialOwners.contactInformation
object
Untergeordnete Attribute anzeigen
ultimateBeneficialOwners.contactInformation.preferredContactMethod
string
ultimateBeneficialOwners.contactInformation.primaryEmail
string
ultimateBeneficialOwners.contactInformation.primaryPhone
string
ultimateBeneficialOwners.controlType
string
Type of control
ultimateBeneficialOwners.employmentInformation
object
Untergeordnete Attribute anzeigen
ultimateBeneficialOwners.employmentInformation.annualIncome
integer
ultimateBeneficialOwners.employmentInformation.currency
string
ultimateBeneficialOwners.employmentInformation.employer
string
ultimateBeneficialOwners.employmentInformation.employmentStartDate
string
ultimateBeneficialOwners.employmentInformation.position
string
ultimateBeneficialOwners.employmentInformation.sourceOfWealth
string
ultimateBeneficialOwners.identificationDocuments
array of object
Untergeordnete Attribute anzeigen
ultimateBeneficialOwners.identificationDocuments.documentNumber
string
ultimateBeneficialOwners.identificationDocuments.documentType
string
ultimateBeneficialOwners.identificationDocuments.expiryDate
string
ultimateBeneficialOwners.identificationDocuments.fileUrls
array of string
ultimateBeneficialOwners.identificationDocuments.issueDate
string
ultimateBeneficialOwners.identificationDocuments.issuingAuthority
string
ultimateBeneficialOwners.identificationDocuments.issuingCountry
string
ultimateBeneficialOwners.ownershipPercentage
integer
Percentage of ownership held by the UBO
ultimateBeneficialOwners.ownershipType
string
Type of ownership
ultimateBeneficialOwners.personalInformation
object
Untergeordnete Attribute anzeigen
ultimateBeneficialOwners.personalInformation.citizenships
array of string
ultimateBeneficialOwners.personalInformation.dateOfBirth
string
ultimateBeneficialOwners.personalInformation.firstName
string
ultimateBeneficialOwners.personalInformation.fullName
string
ultimateBeneficialOwners.personalInformation.gender
string
ultimateBeneficialOwners.personalInformation.identificationNumber
string
ultimateBeneficialOwners.personalInformation.lastName
string
ultimateBeneficialOwners.personalInformation.maritalStatus
string
ultimateBeneficialOwners.personalInformation.middleName
string
ultimateBeneficialOwners.personalInformation.nationality
string
ultimateBeneficialOwners.personalInformation.placeOfBirth
string
ultimateBeneficialOwners.personalInformation.title
string
ultimateBeneficialOwners.politicalExposure
object
Untergeordnete Attribute anzeigen
ultimateBeneficialOwners.politicalExposure.closeAssociatePep
boolean
ultimateBeneficialOwners.politicalExposure.familyMemberPep
boolean
ultimateBeneficialOwners.politicalExposure.isPoliticallyExposed
boolean
ultimateBeneficialOwners.politicalExposure.pepCategory
string
ultimateBeneficialOwners.politicalExposure.pepDetails
string
version
integer
The version of the business profile
Codebeispiel
curl -X GET 'https://api.bird.com/organizations/{organizationId}/profile' \
  -H 'Authorization: AccessKey YOUR_ACCESS_KEY'
PATCH
/organizations/{organizationId}/profile
Update business profile
Anfrage-Payload
addressInformation
object
Untergeordnete Parameter anzeigen
addressInformation.billingAddress
object
Untergeordnete Parameter anzeigen
addressInformation.billingAddress.addressType
string
addressInformation.billingAddress.city
string
addressInformation.billingAddress.countryCode
string
The ISO-3166-1 Alpha-2 code for the country.
addressInformation.billingAddress.postalCode
string
addressInformation.billingAddress.state
string
addressInformation.billingAddress.streetName
string
addressInformation.billingAddress.streetNumber
string
addressInformation.mailingAddress
object
Untergeordnete Parameter anzeigen
addressInformation.mailingAddress.addressType
string
addressInformation.mailingAddress.city
string
addressInformation.mailingAddress.countryCode
string
The ISO-3166-1 Alpha-2 code for the country.
addressInformation.mailingAddress.postalCode
string
addressInformation.mailingAddress.state
string
addressInformation.mailingAddress.streetName
string
addressInformation.mailingAddress.streetNumber
string
addressInformation.operatingAddress
object
Untergeordnete Parameter anzeigen
addressInformation.operatingAddress.addressType
string
addressInformation.operatingAddress.city
string
addressInformation.operatingAddress.countryCode
string
The ISO-3166-1 Alpha-2 code for the country.
addressInformation.operatingAddress.postalCode
string
addressInformation.operatingAddress.state
string
addressInformation.operatingAddress.streetName
string
addressInformation.operatingAddress.streetNumber
string
addressInformation.registeredAddress
object
Untergeordnete Parameter anzeigen
addressInformation.registeredAddress.addressType
string
addressInformation.registeredAddress.city
string
addressInformation.registeredAddress.countryCode
string
The ISO-3166-1 Alpha-2 code for the country.
addressInformation.registeredAddress.postalCode
string
addressInformation.registeredAddress.state
string
addressInformation.registeredAddress.streetName
string
addressInformation.registeredAddress.streetNumber
string
businessDetails
object
Untergeordnete Parameter anzeigen
businessDetails.annualRevenue
integer
businessDetails.businessDescription
string
businessDetails.businessStartDate
string
businessDetails.currency
string
businessDetails.duns
string
businessDetails.entityType
string
businessDetails.giin
string
businessDetails.goodsOrServicesDescription
string
businessDetails.incorporationJurisdiction
string
businessDetails.industryGroup
string
businessDetails.lei
string
businessDetails.numberOfEmployees
integer
businessDetails.operatingCountries
array of string
businessDetails.publiclyListed
boolean
businessDetails.registrationNumber
string
businessDetails.stockExchange
string
businessDetails.taxIdentificationNumber
string
businessDetails.tickerSymbol
string
businessDetails.type
string
The business type.
Possible values: unknown, public, private, personal, education, government, nonprofit
businessDetails.vatNumber
string
businessDetails.vatNumberStatus
string
Possible values: none, pending, valid, invalid
contactInformation
object
Untergeordnete Parameter anzeigen
contactInformation.invoicingEmail
string
contactInformation.primaryEmail
string
contactInformation.primaryPhone
string
contactInformation.secondaryPhone
string
contactInformation.website
string
documents
array of object
Untergeordnete Parameter anzeigen
documents.documentType
string
Type of the document
documents.fileUrls
array of string
List of URLs where the document can be accessed
domain
string
Domain name.
id
string
The profile ID
legalName
string
The name under which this business is registered.
logoUrl
string
name
string
The name under which this business is commonly referred to.
significantContacts
object
Untergeordnete Parameter anzeigen
significantContacts.contacts
array of object
Organization's significant contacts.
Untergeordnete Parameter anzeigen
significantContacts.contacts.contactCategories
array of string
significantContacts.contacts.email
string
significantContacts.contacts.name
string
significantContacts.contacts.phone
string
significantContacts.predefinedContactCategories
array of string
socialMedia
array of object
Untergeordnete Parameter anzeigen
socialMedia.handle
string
The name or handle used on the platform
socialMedia.platform
string
The social media platform
ultimateBeneficialOwners
array of object
Untergeordnete Parameter anzeigen
ultimateBeneficialOwners.addressInformation
object
Untergeordnete Parameter anzeigen
ultimateBeneficialOwners.addressInformation.mailingAddress
object
Untergeordnete Parameter anzeigen
ultimateBeneficialOwners.addressInformation.mailingAddress.addressType
string
ultimateBeneficialOwners.addressInformation.mailingAddress.city
string
ultimateBeneficialOwners.addressInformation.mailingAddress.countryCode
string
The ISO-3166-1 Alpha-2 code for the country.
ultimateBeneficialOwners.addressInformation.mailingAddress.postalCode
string
ultimateBeneficialOwners.addressInformation.mailingAddress.state
string
ultimateBeneficialOwners.addressInformation.mailingAddress.streetName
string
ultimateBeneficialOwners.addressInformation.mailingAddress.streetNumber
string
ultimateBeneficialOwners.addressInformation.residentialAddress
object
Untergeordnete Parameter anzeigen
ultimateBeneficialOwners.addressInformation.residentialAddress.addressType
string
ultimateBeneficialOwners.addressInformation.residentialAddress.city
string
ultimateBeneficialOwners.addressInformation.residentialAddress.countryCode
string
The ISO-3166-1 Alpha-2 code for the country.
ultimateBeneficialOwners.addressInformation.residentialAddress.postalCode
string
ultimateBeneficialOwners.addressInformation.residentialAddress.state
string
ultimateBeneficialOwners.addressInformation.residentialAddress.streetName
string
ultimateBeneficialOwners.addressInformation.residentialAddress.streetNumber
string
ultimateBeneficialOwners.contactInformation
object
Untergeordnete Parameter anzeigen
ultimateBeneficialOwners.contactInformation.preferredContactMethod
string
ultimateBeneficialOwners.contactInformation.primaryEmail
string
ultimateBeneficialOwners.contactInformation.primaryPhone
string
ultimateBeneficialOwners.controlType
string
Type of control
ultimateBeneficialOwners.employmentInformation
object
Untergeordnete Parameter anzeigen
ultimateBeneficialOwners.employmentInformation.annualIncome
integer
ultimateBeneficialOwners.employmentInformation.currency
string
ultimateBeneficialOwners.employmentInformation.employer
string
ultimateBeneficialOwners.employmentInformation.employmentStartDate
string
ultimateBeneficialOwners.employmentInformation.position
string
ultimateBeneficialOwners.employmentInformation.sourceOfWealth
string
ultimateBeneficialOwners.identificationDocuments
array of object
Untergeordnete Parameter anzeigen
ultimateBeneficialOwners.identificationDocuments.documentNumber
string
ultimateBeneficialOwners.identificationDocuments.documentType
string
ultimateBeneficialOwners.identificationDocuments.expiryDate
string
ultimateBeneficialOwners.identificationDocuments.fileUrls
array of string
ultimateBeneficialOwners.identificationDocuments.issueDate
string
ultimateBeneficialOwners.identificationDocuments.issuingAuthority
string
ultimateBeneficialOwners.identificationDocuments.issuingCountry
string
ultimateBeneficialOwners.ownershipPercentage
integer
Percentage of ownership held by the UBO
ultimateBeneficialOwners.ownershipType
string
Type of ownership
ultimateBeneficialOwners.personalInformation
object
Untergeordnete Parameter anzeigen
ultimateBeneficialOwners.personalInformation.citizenships
array of string
ultimateBeneficialOwners.personalInformation.dateOfBirth
string
ultimateBeneficialOwners.personalInformation.firstName
string
ultimateBeneficialOwners.personalInformation.fullName
string
ultimateBeneficialOwners.personalInformation.gender
string
ultimateBeneficialOwners.personalInformation.identificationNumber
string
ultimateBeneficialOwners.personalInformation.lastName
string
ultimateBeneficialOwners.personalInformation.maritalStatus
string
ultimateBeneficialOwners.personalInformation.middleName
string
ultimateBeneficialOwners.personalInformation.nationality
string
ultimateBeneficialOwners.personalInformation.placeOfBirth
string
ultimateBeneficialOwners.personalInformation.title
string
ultimateBeneficialOwners.politicalExposure
object
Untergeordnete Parameter anzeigen
ultimateBeneficialOwners.politicalExposure.closeAssociatePep
boolean
ultimateBeneficialOwners.politicalExposure.familyMemberPep
boolean
ultimateBeneficialOwners.politicalExposure.isPoliticallyExposed
boolean
ultimateBeneficialOwners.politicalExposure.pepCategory
string
ultimateBeneficialOwners.politicalExposure.pepDetails
string
version
integer
The version of the business profile
Antwort-Payload
addressInformation
object
Untergeordnete Attribute anzeigen
addressInformation.billingAddress
object
Untergeordnete Attribute anzeigen
addressInformation.billingAddress.addressType
string
addressInformation.billingAddress.city
string
addressInformation.billingAddress.countryCode
string
The ISO-3166-1 Alpha-2 code for the country.
addressInformation.billingAddress.postalCode
string
addressInformation.billingAddress.state
string
addressInformation.billingAddress.streetName
string
addressInformation.billingAddress.streetNumber
string
addressInformation.mailingAddress
object
Untergeordnete Attribute anzeigen
addressInformation.mailingAddress.addressType
string
addressInformation.mailingAddress.city
string
addressInformation.mailingAddress.countryCode
string
The ISO-3166-1 Alpha-2 code for the country.
addressInformation.mailingAddress.postalCode
string
addressInformation.mailingAddress.state
string
addressInformation.mailingAddress.streetName
string
addressInformation.mailingAddress.streetNumber
string
addressInformation.operatingAddress
object
Untergeordnete Attribute anzeigen
addressInformation.operatingAddress.addressType
string
addressInformation.operatingAddress.city
string
addressInformation.operatingAddress.countryCode
string
The ISO-3166-1 Alpha-2 code for the country.
addressInformation.operatingAddress.postalCode
string
addressInformation.operatingAddress.state
string
addressInformation.operatingAddress.streetName
string
addressInformation.operatingAddress.streetNumber
string
addressInformation.registeredAddress
object
Untergeordnete Attribute anzeigen
addressInformation.registeredAddress.addressType
string
addressInformation.registeredAddress.city
string
addressInformation.registeredAddress.countryCode
string
The ISO-3166-1 Alpha-2 code for the country.
addressInformation.registeredAddress.postalCode
string
addressInformation.registeredAddress.state
string
addressInformation.registeredAddress.streetName
string
addressInformation.registeredAddress.streetNumber
string
businessDetails
object
Untergeordnete Attribute anzeigen
businessDetails.annualRevenue
integer
businessDetails.businessDescription
string
businessDetails.businessStartDate
string
businessDetails.currency
string
businessDetails.duns
string
businessDetails.entityType
string
businessDetails.giin
string
businessDetails.goodsOrServicesDescription
string
businessDetails.incorporationJurisdiction
string
businessDetails.industryGroup
string
businessDetails.lei
string
businessDetails.numberOfEmployees
integer
businessDetails.operatingCountries
array of string
businessDetails.publiclyListed
boolean
businessDetails.registrationNumber
string
businessDetails.stockExchange
string
businessDetails.taxIdentificationNumber
string
businessDetails.tickerSymbol
string
businessDetails.type
string
The business type.
Possible values: unknown, public, private, personal, education, government, nonprofit
businessDetails.vatNumber
string
businessDetails.vatNumberStatus
string
Possible values: none, pending, valid, invalid
contactInformation
object
Untergeordnete Attribute anzeigen
contactInformation.invoicingEmail
string
contactInformation.primaryEmail
string
contactInformation.primaryPhone
string
contactInformation.secondaryPhone
string
contactInformation.website
string
documents
array of object
Untergeordnete Attribute anzeigen
documents.documentType
string
Type of the document
documents.fileUrls
array of string
List of URLs where the document can be accessed
domain
string
Domain name.
id
string
The profile ID
legalName
string
The name under which this business is registered.
logoUrl
string
name
string
The name under which this business is commonly referred to.
significantContacts
object
Untergeordnete Attribute anzeigen
significantContacts.contacts
array of object
Organization's significant contacts.
Untergeordnete Attribute anzeigen
significantContacts.contacts.contactCategories
array of string
significantContacts.contacts.email
string
significantContacts.contacts.name
string
significantContacts.contacts.phone
string
significantContacts.predefinedContactCategories
array of string
socialMedia
array of object
Untergeordnete Attribute anzeigen
socialMedia.handle
string
The name or handle used on the platform
socialMedia.platform
string
The social media platform
ultimateBeneficialOwners
array of object
Untergeordnete Attribute anzeigen
ultimateBeneficialOwners.addressInformation
object
Untergeordnete Attribute anzeigen
ultimateBeneficialOwners.addressInformation.mailingAddress
object
Untergeordnete Attribute anzeigen
ultimateBeneficialOwners.addressInformation.mailingAddress.addressType
string
ultimateBeneficialOwners.addressInformation.mailingAddress.city
string
ultimateBeneficialOwners.addressInformation.mailingAddress.countryCode
string
The ISO-3166-1 Alpha-2 code for the country.
ultimateBeneficialOwners.addressInformation.mailingAddress.postalCode
string
ultimateBeneficialOwners.addressInformation.mailingAddress.state
string
ultimateBeneficialOwners.addressInformation.mailingAddress.streetName
string
ultimateBeneficialOwners.addressInformation.mailingAddress.streetNumber
string
ultimateBeneficialOwners.addressInformation.residentialAddress
object
Untergeordnete Attribute anzeigen
ultimateBeneficialOwners.addressInformation.residentialAddress.addressType
string
ultimateBeneficialOwners.addressInformation.residentialAddress.city
string
ultimateBeneficialOwners.addressInformation.residentialAddress.countryCode
string
The ISO-3166-1 Alpha-2 code for the country.
ultimateBeneficialOwners.addressInformation.residentialAddress.postalCode
string
ultimateBeneficialOwners.addressInformation.residentialAddress.state
string
ultimateBeneficialOwners.addressInformation.residentialAddress.streetName
string
ultimateBeneficialOwners.addressInformation.residentialAddress.streetNumber
string
ultimateBeneficialOwners.contactInformation
object
Untergeordnete Attribute anzeigen
ultimateBeneficialOwners.contactInformation.preferredContactMethod
string
ultimateBeneficialOwners.contactInformation.primaryEmail
string
ultimateBeneficialOwners.contactInformation.primaryPhone
string
ultimateBeneficialOwners.controlType
string
Type of control
ultimateBeneficialOwners.employmentInformation
object
Untergeordnete Attribute anzeigen
ultimateBeneficialOwners.employmentInformation.annualIncome
integer
ultimateBeneficialOwners.employmentInformation.currency
string
ultimateBeneficialOwners.employmentInformation.employer
string
ultimateBeneficialOwners.employmentInformation.employmentStartDate
string
ultimateBeneficialOwners.employmentInformation.position
string
ultimateBeneficialOwners.employmentInformation.sourceOfWealth
string
ultimateBeneficialOwners.identificationDocuments
array of object
Untergeordnete Attribute anzeigen
ultimateBeneficialOwners.identificationDocuments.documentNumber
string
ultimateBeneficialOwners.identificationDocuments.documentType
string
ultimateBeneficialOwners.identificationDocuments.expiryDate
string
ultimateBeneficialOwners.identificationDocuments.fileUrls
array of string
ultimateBeneficialOwners.identificationDocuments.issueDate
string
ultimateBeneficialOwners.identificationDocuments.issuingAuthority
string
ultimateBeneficialOwners.identificationDocuments.issuingCountry
string
ultimateBeneficialOwners.ownershipPercentage
integer
Percentage of ownership held by the UBO
ultimateBeneficialOwners.ownershipType
string
Type of ownership
ultimateBeneficialOwners.personalInformation
object
Untergeordnete Attribute anzeigen
ultimateBeneficialOwners.personalInformation.citizenships
array of string
ultimateBeneficialOwners.personalInformation.dateOfBirth
string
ultimateBeneficialOwners.personalInformation.firstName
string
ultimateBeneficialOwners.personalInformation.fullName
string
ultimateBeneficialOwners.personalInformation.gender
string
ultimateBeneficialOwners.personalInformation.identificationNumber
string
ultimateBeneficialOwners.personalInformation.lastName
string
ultimateBeneficialOwners.personalInformation.maritalStatus
string
ultimateBeneficialOwners.personalInformation.middleName
string
ultimateBeneficialOwners.personalInformation.nationality
string
ultimateBeneficialOwners.personalInformation.placeOfBirth
string
ultimateBeneficialOwners.personalInformation.title
string
ultimateBeneficialOwners.politicalExposure
object
Untergeordnete Attribute anzeigen
ultimateBeneficialOwners.politicalExposure.closeAssociatePep
boolean
ultimateBeneficialOwners.politicalExposure.familyMemberPep
boolean
ultimateBeneficialOwners.politicalExposure.isPoliticallyExposed
boolean
ultimateBeneficialOwners.politicalExposure.pepCategory
string
ultimateBeneficialOwners.politicalExposure.pepDetails
string
version
integer
The version of the business profile
Codebeispiel
curl -X PATCH 'https://api.bird.com/organizations/{organizationId}/profile' \
  -H 'Authorization: AccessKey YOUR_ACCESS_KEY'