Profile

Get business profile

get

Authorizations

Path parameters

organizationIdstringRequired

The organization ID

Responses

200

OK

application/json

404

Resource not found

application/json

get

HTTPcURLJavaScriptPython

GET /organizations/{organizationId}/profile HTTP/1.1
Host: 
Authorization: Bearer jwt
Accept: */*

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "version": 1,
  "name": "text",
  "domain": "example.com",
  "legalName": "text",
  "logoUrl": "text",
  "socialMedia": [
    {
      "platform": "text",
      "handle": "text"
    }
  ],
  "businessDetails": {
    "entityType": "text",
    "type": "unknown",
    "incorporationJurisdiction": "text",
    "registrationNumber": "text",
    "taxIdentificationNumber": "text",
    "vatNumber": "text",
    "lei": "text",
    "industryGroup": "text",
    "businessDescription": "text",
    "goodsOrServicesDescription": "text",
    "businessStartDate": "text",
    "numberOfEmployees": 1,
    "annualRevenue": 1,
    "currency": "text",
    "operatingCountries": [
      "text"
    ],
    "publiclyListed": true,
    "stockExchange": "text",
    "tickerSymbol": "text"
  },
  "addressInformation": {
    "registeredAddress": {
      "streetName": "text",
      "streetNumber": "text",
      "city": "text",
      "postalCode": "text",
      "state": "text",
      "countryCode": "text",
      "addressType": "text"
    },
    "operatingAddress": {
      "streetName": "text",
      "streetNumber": "text",
      "city": "text",
      "postalCode": "text",
      "state": "text",
      "countryCode": "text",
      "addressType": "text"
    },
    "mailingAddress": {
      "streetName": "text",
      "streetNumber": "text",
      "city": "text",
      "postalCode": "text",
      "state": "text",
      "countryCode": "text",
      "addressType": "text"
    },
    "billingAddress": {
      "streetName": "text",
      "streetNumber": "text",
      "city": "text",
      "postalCode": "text",
      "state": "text",
      "countryCode": "text",
      "addressType": "text"
    }
  },
  "contactInformation": {
    "primaryPhone": "text",
    "secondaryPhone": "text",
    "primaryEmail": "text",
    "invoicingEmail": "text",
    "website": "https://example.com"
  },
  "documents": [
    {
      "fileUrls": [
        "https://example.com"
      ],
      "documentType": "text"
    }
  ],
  "ultimateBeneficialOwners": [
    {
      "ownershipPercentage": 1,
      "ownershipType": "text",
      "controlType": "text",
      "personalInformation": {
        "title": "text",
        "firstName": "text",
        "middleName": "text",
        "lastName": "text",
        "fullName": "text",
        "dateOfBirth": "text",
        "placeOfBirth": "text",
        "nationality": "text",
        "citizenships": [
          "text"
        ],
        "gender": "text",
        "maritalStatus": "text",
        "identificationNumber": "text"
      },
      "identificationDocuments": [
        {
          "fileUrls": [
            "text"
          ],
          "documentType": "text",
          "documentNumber": "text",
          "issuingCountry": "text",
          "issueDate": "text",
          "expiryDate": "text",
          "issuingAuthority": "text"
        }
      ],
      "addressInformation": {
        "residentialAddress": {
          "streetName": "text",
          "streetNumber": "text",
          "city": "text",
          "postalCode": "text",
          "state": "text",
          "countryCode": "text",
          "addressType": "text"
        },
        "mailingAddress": {
          "streetName": "text",
          "streetNumber": "text",
          "city": "text",
          "postalCode": "text",
          "state": "text",
          "countryCode": "text",
          "addressType": "text"
        }
      },
      "contactInformation": {
        "primaryPhone": "text",
        "primaryEmail": "text",
        "preferredContactMethod": "text"
      },
      "employmentInformation": {
        "position": "text",
        "employer": "text",
        "employmentStartDate": "text",
        "annualIncome": 1,
        "currency": "text",
        "sourceOfWealth": "text"
      },
      "politicalExposure": {
        "isPoliticallyExposed": true,
        "pepCategory": "text",
        "pepDetails": "text",
        "familyMemberPep": true,
        "closeAssociatePep": true
      }
    }
  ],
  "significantContacts": {
    "contacts": [
      {
        "name": "text",
        "email": "text",
        "contactCategories": [
          "text"
        ],
        "phone": "text"
      }
    ],
    "predefinedContactCategories": [
      "text"
    ]
  }
}

Update business profile

patch

Authorizations

Path parameters

organizationIdstringRequired

The organization ID

Body

idstring · uuidOptional

The profile ID

versionintegerOptional

The version of the business profile

namestring · max: 256Optional

The name under which this business is commonly referred to.

domainstring · domain · max: 253Optional

Domain name.

Example: example.com

legalNamestring · max: 256Optional

The name under which this business is registered.

logoUrlstringOptionalPattern: ^|https://

Responses

200

OK

application/json

404

Resource not found

application/json

422

Request validation failed

application/json

patch

HTTPcURLJavaScriptPython

PATCH /organizations/{organizationId}/profile HTTP/1.1
Host: 
Authorization: Bearer jwt
Content-Type: application/json
Accept: */*
Content-Length: 2918

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "version": 1,
  "name": "text",
  "domain": "example.com",
  "legalName": "text",
  "logoUrl": "text",
  "socialMedia": [
    {
      "platform": "text",
      "handle": "text"
    }
  ],
  "businessDetails": {
    "entityType": "text",
    "type": "unknown",
    "incorporationJurisdiction": "text",
    "registrationNumber": "text",
    "taxIdentificationNumber": "text",
    "vatNumber": "text",
    "lei": "text",
    "industryGroup": "text",
    "businessDescription": "text",
    "goodsOrServicesDescription": "text",
    "businessStartDate": "text",
    "numberOfEmployees": 1,
    "annualRevenue": 1,
    "currency": "text",
    "operatingCountries": [
      "text"
    ],
    "publiclyListed": true,
    "stockExchange": "text",
    "tickerSymbol": "text"
  },
  "addressInformation": {
    "registeredAddress": {
      "streetName": "text",
      "streetNumber": "text",
      "city": "text",
      "postalCode": "text",
      "state": "text",
      "countryCode": "text",
      "addressType": "text"
    },
    "operatingAddress": {
      "streetName": "text",
      "streetNumber": "text",
      "city": "text",
      "postalCode": "text",
      "state": "text",
      "countryCode": "text",
      "addressType": "text"
    },
    "mailingAddress": {
      "streetName": "text",
      "streetNumber": "text",
      "city": "text",
      "postalCode": "text",
      "state": "text",
      "countryCode": "text",
      "addressType": "text"
    },
    "billingAddress": {
      "streetName": "text",
      "streetNumber": "text",
      "city": "text",
      "postalCode": "text",
      "state": "text",
      "countryCode": "text",
      "addressType": "text"
    }
  },
  "contactInformation": {
    "primaryPhone": "text",
    "secondaryPhone": "text",
    "primaryEmail": "text",
    "invoicingEmail": "text",
    "website": "https://example.com"
  },
  "documents": [
    {
      "fileUrls": [
        "https://example.com"
      ],
      "documentType": "text"
    }
  ],
  "ultimateBeneficialOwners": [
    {
      "ownershipPercentage": 1,
      "ownershipType": "text",
      "controlType": "text",
      "personalInformation": {
        "title": "text",
        "firstName": "text",
        "middleName": "text",
        "lastName": "text",
        "fullName": "text",
        "dateOfBirth": "text",
        "placeOfBirth": "text",
        "nationality": "text",
        "citizenships": [
          "text"
        ],
        "gender": "text",
        "maritalStatus": "text",
        "identificationNumber": "text"
      },
      "identificationDocuments": [
        {
          "fileUrls": [
            "text"
          ],
          "documentType": "text",
          "documentNumber": "text",
          "issuingCountry": "text",
          "issueDate": "text",
          "expiryDate": "text",
          "issuingAuthority": "text"
        }
      ],
      "addressInformation": {
        "residentialAddress": {
          "streetName": "text",
          "streetNumber": "text",
          "city": "text",
          "postalCode": "text",
          "state": "text",
          "countryCode": "text",
          "addressType": "text"
        },
        "mailingAddress": {
          "streetName": "text",
          "streetNumber": "text",
          "city": "text",
          "postalCode": "text",
          "state": "text",
          "countryCode": "text",
          "addressType": "text"
        }
      },
      "contactInformation": {
        "primaryPhone": "text",
        "primaryEmail": "text",
        "preferredContactMethod": "text"
      },
      "employmentInformation": {
        "position": "text",
        "employer": "text",
        "employmentStartDate": "text",
        "annualIncome": 1,
        "currency": "text",
        "sourceOfWealth": "text"
      },
      "politicalExposure": {
        "isPoliticallyExposed": true,
        "pepCategory": "text",
        "pepDetails": "text",
        "familyMemberPep": true,
        "closeAssociatePep": true
      }
    }
  ],
  "significantContacts": {
    "contacts": [
      {
        "name": "text",
        "email": "text",
        "contactCategories": [
          "text"
        ],
        "phone": "text"
      }
    ],
    "predefinedContactCategories": [
      "text"
    ]
  }
}

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "version": 1,
  "name": "text",
  "domain": "example.com",
  "legalName": "text",
  "logoUrl": "text",
  "socialMedia": [
    {
      "platform": "text",
      "handle": "text"
    }
  ],
  "businessDetails": {
    "entityType": "text",
    "type": "unknown",
    "incorporationJurisdiction": "text",
    "registrationNumber": "text",
    "taxIdentificationNumber": "text",
    "vatNumber": "text",
    "lei": "text",
    "industryGroup": "text",
    "businessDescription": "text",
    "goodsOrServicesDescription": "text",
    "businessStartDate": "text",
    "numberOfEmployees": 1,
    "annualRevenue": 1,
    "currency": "text",
    "operatingCountries": [
      "text"
    ],
    "publiclyListed": true,
    "stockExchange": "text",
    "tickerSymbol": "text"
  },
  "addressInformation": {
    "registeredAddress": {
      "streetName": "text",
      "streetNumber": "text",
      "city": "text",
      "postalCode": "text",
      "state": "text",
      "countryCode": "text",
      "addressType": "text"
    },
    "operatingAddress": {
      "streetName": "text",
      "streetNumber": "text",
      "city": "text",
      "postalCode": "text",
      "state": "text",
      "countryCode": "text",
      "addressType": "text"
    },
    "mailingAddress": {
      "streetName": "text",
      "streetNumber": "text",
      "city": "text",
      "postalCode": "text",
      "state": "text",
      "countryCode": "text",
      "addressType": "text"
    },
    "billingAddress": {
      "streetName": "text",
      "streetNumber": "text",
      "city": "text",
      "postalCode": "text",
      "state": "text",
      "countryCode": "text",
      "addressType": "text"
    }
  },
  "contactInformation": {
    "primaryPhone": "text",
    "secondaryPhone": "text",
    "primaryEmail": "text",
    "invoicingEmail": "text",
    "website": "https://example.com"
  },
  "documents": [
    {
      "fileUrls": [
        "https://example.com"
      ],
      "documentType": "text"
    }
  ],
  "ultimateBeneficialOwners": [
    {
      "ownershipPercentage": 1,
      "ownershipType": "text",
      "controlType": "text",
      "personalInformation": {
        "title": "text",
        "firstName": "text",
        "middleName": "text",
        "lastName": "text",
        "fullName": "text",
        "dateOfBirth": "text",
        "placeOfBirth": "text",
        "nationality": "text",
        "citizenships": [
          "text"
        ],
        "gender": "text",
        "maritalStatus": "text",
        "identificationNumber": "text"
      },
      "identificationDocuments": [
        {
          "fileUrls": [
            "text"
          ],
          "documentType": "text",
          "documentNumber": "text",
          "issuingCountry": "text",
          "issueDate": "text",
          "expiryDate": "text",
          "issuingAuthority": "text"
        }
      ],
      "addressInformation": {
        "residentialAddress": {
          "streetName": "text",
          "streetNumber": "text",
          "city": "text",
          "postalCode": "text",
          "state": "text",
          "countryCode": "text",
          "addressType": "text"
        },
        "mailingAddress": {
          "streetName": "text",
          "streetNumber": "text",
          "city": "text",
          "postalCode": "text",
          "state": "text",
          "countryCode": "text",
          "addressType": "text"
        }
      },
      "contactInformation": {
        "primaryPhone": "text",
        "primaryEmail": "text",
        "preferredContactMethod": "text"
      },
      "employmentInformation": {
        "position": "text",
        "employer": "text",
        "employmentStartDate": "text",
        "annualIncome": 1,
        "currency": "text",
        "sourceOfWealth": "text"
      },
      "politicalExposure": {
        "isPoliticallyExposed": true,
        "pepCategory": "text",
        "pepDetails": "text",
        "familyMemberPep": true,
        "closeAssociatePep": true
      }
    }
  ],
  "significantContacts": {
    "contacts": [
      {
        "name": "text",
        "email": "text",
        "contactCategories": [
          "text"
        ],
        "phone": "text"
      }
    ],
    "predefinedContactCategories": [
      "text"
    ]
  }
}