Sign in

v1

latestOpenAPI 3.0.22026-07-24113565544.0 KB
Entities

Update Entity

Updates a Entity.

patch/entities/{entityId}

Path parameters

entityIdstring required

Unique ID of the Entity to update.

Request body

ibIDstring

The unique identifier of the firm.

type'CORPORATION' | 'LLC' | 'TRUST' | 'PARTNERSHIP'

The type of the entity.

subType'S_CORPORATION' | 'C_CORPORATION' | 'LLC_SINGLE_MEMBER' | 'LLC_C_CORPORATION' | 'LLC_S_CORPORATION' | 'LLC_PARTNERSHIP' | 'PARTNERSHIP_GENERAL' | 'PARTNERSHIP_LIMITED' | 'SMSF'

The subtype of the entity. Required for 'CORPORATION', 'LLC', and 'PARTNERSHIP'; optional for 'TRUST'. Valid values by type — CORPORATION: S_CORPORATION, C_CORPORATION; LLC: LLC_SINGLE_MEMBER, LLC_C_CORPORATION, LLC_S_CORPORATION, LLC_PARTNERSHIP; PARTNERSHIP: PARTNERSHIP_GENERAL, PARTNERSHIP_LIMITED; TRUST: SMSF.

metadataobject

Additional metadata for the entity.

financialAffiliationsstring[]

List of financial affiliations.

Example request

{
  "ibID": "80f9b672-120d-4b73-9cc9-42fb3262c4b9",
  "type": "CORPORATION",
  "subType": "C_CORPORATION",
  "attributes": {
    "name": "Better Investment",
    "dba": "BI",
    "incorporationCountry": "USA",
    "incorporationProvince": "NY",
    "incorporationDate": "2019-01-01"
  },
  "identifications": {
    "ein": "12-3456789",
    "ftin": "12-3456789",
    "giin": "123456.12345.12.12.123",
    "ssn": "891234589"
  },
  "contact": {
    "addresses": {
      "primary": {
        "street1": "123 Main Street",
        "street2": "suite 101",
        "city": "Wilmington",
        "province": "DE",
        "zipcode": "19801",
        "country": "USA"
      }
    },
    "phone": "+12345678911",
    "email": "hello@acme.com",
    "website": "www.acme.com"
  },
  "metadata": {
    "myCustomKey": "myCustomValue"
  },
  "kyb": {
    "status": "KYB_APPROVED",
    "statusWhen": "2024-09-09T15:20:05Z",
    "verificationKey": "VERIFICATION_KEY_12345"
  },
  "disclosures": {
    "termsOfUse": {
      "agreed": true,
      "signedBy": "John Doe",
      "signedWhen": "2024-09-09T15:20:05Z"
    },
    "customerAgreement": {
      "agreed": true,
      "signedBy": "John Doe",
      "signedWhen": "2024-09-09T15:20:05Z"
    },
    "rule14b": {
      "agreed": true,
      "signedBy": "John Doe",
      "signedWhen": "2024-09-09T15:20:05Z"
    },
    "extendedHoursAgreement": {
      "agreed": true,
      "signedBy": "John Doe",
      "signedWhen": "2024-09-09T15:20:05Z"
    },
    "marginAgreement": {
      "agreed": true,
      "signedBy": "John Doe",
      "signedWhen": "2024-09-09T15:20:05Z"
    },
    "fpslAgreement": {
      "agreed": true,
      "signedBy": "John Doe",
      "signedWhen": "2024-09-09T15:20:05Z"
    },
    "privacyPolicy": {
      "agreed": true,
      "signedBy": "John Doe",
      "signedWhen": "2024-09-09T15:20:05Z"
    }
  },
  "investorProfile": {
    "annualRevenue": 1000000,
    "netWorthTotal": 5000000,
    "investmentObjective": "GROWTH",
    "riskTolerance": "HIGH",
    "liquidityNeeds": "LOW",
    "investmentExperience": "YRS_5_10",
    "timeHorizon": "LONG_TERM",
    "equities": {
      "monthlyTransactionAmount": "$50K_TO_$250K",
      "investmentExperience": "YRS_5_10"
    },
    "fixedIncome": {
      "monthlyTransactionAmount": "$50K_TO_$250K",
      "investmentExperience": "YRS_5_10"
    }
  },
  "financialAffiliations": [
    "Bank of Narnia",
    "Gringotts Bank"
  ],
  "industryClassification": {
    "NAICS": {
      "code": 111110
    },
    "Other": {
      "code": "ENERGY"
    }
  }
}

Response

Updating a Entity was Successful.

idstring

The unique identifier of the entity.

ibIDstring

The unique identifier of the firm.

wlpIDstring

The WLP identifier of the entity.

type'CORPORATION' | 'LLC' | 'TRUST' | 'PARTNERSHIP'

The type of the entity.

subType'S_CORPORATION' | 'C_CORPORATION' | 'LLC_SINGLE_MEMBER' | 'LLC_C_CORPORATION' | 'LLC_S_CORPORATION' | 'LLC_PARTNERSHIP' | 'PARTNERSHIP_GENERAL' | 'PARTNERSHIP_LIMITED' | 'SMSF'

The subtype of the entity.

metadataobject

Additional metadata for the entity.

financialAffiliationsstring[]

List of financial affiliations.

status'PENDING' | 'APPROVED' | 'REJECTED' | 'REVOKED' | 'CLOSED'

The status of the business entity.

createdAtstring

The date and time when the entity was created.

updatedAtstring

The date and time when the entity was last updated.

createdBystring

The user who created the entity.

updatedBystring

The user who last updated the entity.

Example response

{
  "id": "83096bad-c99b-4d48-9819-364a46c7cqw2",
  "ibID": "80f9b672-120d-4b73-9cc9-42fb3262c4b9",
  "wlpID": "DW",
  "type": "CORPORATION",
  "subType": "C_CORPORATION",
  "attributes": {
    "name": "Better Investment",
    "dba": "BI",
    "incorporationCountry": "USA",
    "incorporationProvince": "NY",
    "incorporationDate": "2019-01-01"
  },
  "identifications": {
    "EIN": "12-3456789",
    "FTIN": "12-3456789",
    "GIIN": "123456.12345.12.12.123",
    "SSN": "891234589"
  },
  "contact": {
    "addresses": {
      "PRIMARY": {
        "street1": "123 Main Street",
        "street2": "suite 101",
        "city": "Wilmington",
        "province": "DE",
        "zipcode": "19801",
        "country": "USA"
      }
    },
    "phone": "+12345678911",
    "email": "hello@acme.com",
    "website": "www.acme.com"
  },
  "metadata": {
    "myCustomKey": "myCustomValue"
  },
  "disclosures": {
    "termsOfUse": {
      "agreed": true,
      "signedBy": "John Doe",
      "signedWhen": "2024-09-09T15:20:05Z"
    },
    "customerAgreement": {
      "agreed": true,
      "signedBy": "John Doe",
      "signedWhen": "2024-09-09T15:20:05Z"
    },
    "rule14b": {
      "agreed": true,
      "signedBy": "John Doe",
      "signedWhen": "2024-09-09T15:20:05Z"
    },
    "extendedHoursAgreement": {
      "agreed": true,
      "signedBy": "John Doe",
      "signedWhen": "2024-09-09T15:20:05Z"
    },
    "marginAgreement": {
      "agreed": true,
      "signedBy": "John Doe",
      "signedWhen": "2024-09-09T15:20:05Z"
    },
    "fpslAgreement": {
      "agreed": true,
      "signedBy": "John Doe",
      "signedWhen": "2024-09-09T15:20:05Z"
    },
    "privacyPolicy": {
      "agreed": true,
      "signedBy": "John Doe",
      "signedWhen": "2024-09-09T15:20:05Z"
    }
  },
  "financialAffiliations": [
    "Bank of Narnia",
    "Gringotts Bank"
  ],
  "industryClassification": {
    "NAICS": {
      "code": 111110
    },
    "Other": {
      "code": "ENERGY"
    }
  },
  "directors": [
    {
      "id": "684ca44e-1d8d-49f0-bd49-2761eb84df43",
      "roles": [
        "CONTROL_PERSON"
      ],
      "title": "DevDirector",
      "firstName": "Manoj",
      "lastName": "Krishna",
      "percentage": 0.25,
      "controlContact": true,
      "kycStatus": "KYC_READY"
    }
  ],
  "taxData": {
    "fatcaData": {
      "applicable": true,
      "applicableFrom": "2024-12-12T02:40:18.421371Z",
      "setBy": "SYSTEM"
    },
    "vendor": {
      "COMPLY_EXCHANGE": {
        "name": "Comply Exchange",
        "taxFormUrl": "www.tax.com",
        "formUrlDate": "2023-11-01T12:34:56Z"
      }
    },
    "data": {
      "W8BENE": {
        "formType": "W8BENE",
        "status": "TAX_APPROVED",
        "statusWhen": "2025-09-29T17:28:31.047Z",
        "statusBy": "COMPLY_EXCHANGE",
        "receivedFrom": "Comply Exchange",
        "receivedWhen": "2025-09-29T17:28:31.047Z",
        "expiresWhen": "2028-12-31",
        "taxTreatyBenefitClaimed": true,
        "chapter3StatusW8": "CORPORATION",
        "chapter4StatusW8": "ACTIVE_NFFE",
        "chapter3Status1042S": "15",
        "chapter4Status1042S": "22"
      }
    }
  },
  "investorProfile": {
    "annualRevenue": 1000000,
    "netWorthTotal": 5000000,
    "investmentObjective": "GROWTH",
    "riskTolerance": "HIGH",
    "liquidityNeeds": "LOW",
    "investmentExperience": "YRS_5_10",
    "timeHorizon": "LONG_TERM",
    "equities": {
      "monthlyTransactionAmount": "$50K_TO_$250K",
      "investmentExperience": "YRS_5_10"
    },
    "fixedIncome": {
      "monthlyTransactionAmount": "$50K_TO_$250K",
      "investmentExperience": "YRS_5_10"
    }
  },
  "kyb": {
    "status": "KYB_APPROVED",
    "statusWhen": "2024-09-09T15:20:05Z",
    "verificationKey": "VERIFICATION_KEY_12345",
    "statusBy": "{{partner ID}}",
    "reasons": [
      {
        "code": "P201",
        "description": "KYB has been approved based on information provided by the partner."
      }
    ]
  },
  "tax": {
    "status": "TAX_READY",
    "message": "Entity is ready for tax processing"
  },
  "status": "PENDING",
  "createdAt": "2024-12-12T02:40:18.452756Z",
  "updatedAt": "2024-12-16T22:51:23.340323Z",
  "createdBy": "59cf3b9c-6557-4010-b19b-6a3750c4b533",
  "updatedBy": "59cf3b9c-6557-4010-b19b-6a3750c4b533"
}