Skip to main content

Get company details

GET 
/companies/:id/details

get a Company details.

Request​

Path Parameters

    id uuidrequired

Responses​

Successful response

Schema
    id uuidrequired
    cmsProjectId stringrequired
    externalCustomerId stringnullablerequired
    riskScore stringnullablerequired

    Possible values: [Low, Medium, High, No risk]

    type stringnullablerequired

    Possible values: [Individual, Company]

    onboardingLevel stringnullablerequired

    Possible values: [Sign-up, AML screening, KYC, Questionaire, Onboarded, Onboarding, KYB, Onboarded]

    status stringnullablerequired

    Possible values: [Active, Rejected, Dormant, To be reviewed, Failed, Escalated, Terminated, No status]

    createdAt date-timerequired
    updatedAt date-timerequired
    createdBy stringrequired
    updatedBy stringrequired
    reason stringnullable
    externalId string
    beneficiaries objectnullable
    individualBeneficiaries object[]nullable
  • Array [
    • id stringrequired
    beneficiaryType stringnullable

    Possible values: [ubo, shareholder, representative]

    name stringrequired
    email email
    beneficiaryPositions object[]nullable
  • Array [
    • anyOf

    string

    Possible values: [director, shareholder, other]

  • ]
    • inRegistry booleannullable
    status stringrequired

    Possible values: [Active, Rejected, Dormant, To be reviewed, Failed, Escalated, Terminated, No status]

    customerType stringrequired

    Possible values: [Individual, Company]

  • ]
    • companyBeneficiaries object[]nullable
  • Array [
    • id stringrequired
    beneficiaryType stringnullable

    Possible values: [ubo, shareholder, representative]

    name stringrequired
    email email
    beneficiaryPositions object[]nullable
  • Array [
    • anyOf

    string

    Possible values: [director, shareholder, other]

  • ]
    • inRegistry booleannullable
    status stringrequired

    Possible values: [Active, Rejected, Dormant, To be reviewed, Failed, Escalated, Terminated, No status]

    customerType stringrequired

    Possible values: [Individual, Company]

  • ]
    • companyClaims object[]nullable
  • Array [
    • id uuidrequired
    customerId uuidrequired
    sub stringnullablerequired
    companyName stringnullablerequired
    registrationNumber stringnullablerequired
    country stringnullable

    Possible values: [AFG, ALB, DZA, ASM, AND, AGO, AIA, ATA, ATG, ARG, ARM, ABW, AUS, AUT, AZE, BHS, BHR, BGD, BRB, BLR, BEL, BLZ, BEN, BMU, BTN, BOL, BES, BIH, BWA, BVT, BRA, IOT, BRN, BGR, BFA, BDI, CPV, KHM, CMR, CAN, CYM, CAF, TCD, CHL, CHN, CXR, CCK, COL, COM, COD, COG, COK, CRI, HRV, CUB, CUW, CYP, CZE, CIV, DNK, DJI, DMA, DOM, ECU, EGY, SLV, GNQ, ERI, EST, SWZ, ETH, FLK, FRO, FJI, FIN, FRA, GUF, PYF, ATF, GAB, GMB, GEO, DEU, GHA, GIB, GRC, GRL, GRD, GLP, GUM, GTM, GGY, GIN, GNB, GUY, HTI, HMD, VAT, HND, HKG, HUN, ISL, IND, IDN, IRN, IRQ, IRL, IMN, ISR, ITA, JAM, JPN, JEY, JOR, KAZ, KEN, KIR, PRK, KOR, KWT, KGZ, LAO, LVA, LBN, LSO, LBR, LBY, LIE, LTU, LUX, MAC, MDG, MWI, MYS, MDV, MLI, MLT, MHL, MTQ, MRT, MUS, MYT, MEX, FSM, MDA, MCO, MNG, MNE, MSR, MAR, MOZ, MMR, NAM, NRU, NPL, NLD, NCL, NZL, NIC, NER, NGA, NIU, NFK, MNP, NOR, OMN, PAK, PLW, PSE, PAN, PNG, PRY, PER, PHL, PCN, POL, PRT, PRI, QAT, MKD, ROU, RUS, RWA, REU, BLM, SHN, KNA, LCA, MAF, SPM, VCT, WSM, SMR, STP, SAU, SEN, SRB, SYC, SLE, SGP, SXM, SVK, SVN, SLB, SOM, ZAF, SGS, SSD, ESP, LKA, SDN, SUR, SJM, SWE, CHE, SYR, TWN, TJK, TZA, THA, TLS, TGO, TKL, TON, TTO, TUN, TUR, TKM, TCA, TUV, UGA, UKR, ARE, GBR, UMI, USA, URY, UZB, VUT, VEN, VNM, VGB, VIR, WLF, ESH, YEM, ZMB, ZWE, ALA, ANT, XKX]

    Citizenship status of the credential subject - ISO 3166-1 alpha-3 country code (https://www.iban.com/country-codes)

    legalAddress stringnullablerequired
    incorporatedOn stringnullablerequired
    type stringnullablerequired
    email stringnullablerequired
    phone stringnullablerequired
    controlScheme stringnullablerequired
    taxId stringnullablerequired
    registrationLocation stringnullablerequired
    website stringnullablerequired
    postalAddress stringnullablerequired
    updatedAt date-timenullable
    createdAt date-timenullablerequired
    createdBy stringrequired
    updatedBy stringrequired
    addresses string[]
    beneficiaries object[]
  • Array [
    • applicantId stringrequired
    type stringrequired

    Possible values: [ubo, shareholder, representative]

    positions string[]nullable
    inRegistry booleannullable
    imageIds string[]nullable
  • ]
  • ]
    • documents object[]nullable
  • Array [
    • documentId uuidrequired
    customerId uuidrequired
    documentType stringrequired

    Possible values: [proof_of_residence, company_document, video_kyc]

    metadata object required
    anyOf
    sumsubImageId numberrequired
    mediaType stringrequired

    Possible values: [image/jpg, image/jpeg, image/png, application/pdf, video/mp4, video/webm, video/quicktime]

    journeyId stringrequired
    documentType stringrequired

    Possible values: [INCORPORATION_CERT, INCORPORATION_ARTICLES, SHAREHOLDER_REGISTRY]

    name string
    entryDate integerrequired
    entryTime stringrequired
    isSandbox booleanrequired
    createdAt date-timerequired
    updatedAt date-timerequired
    createdBy stringrequired
    updatedBy stringrequired
    document objectrequired
    id uuidrequired
    objectKey uuidrequired
    filename stringrequired
    mimetype stringrequired
    description stringnullablerequired
    cmsProjectId stringrequired
    createdAt date-timerequired
    createdBy stringrequired
    presignedUrl stringrequired
  • ]
Loading...