Variable identityApiConst

Type Declaration

• Readonly/v1/identity: {
      get: {
          description: "If no results are found, an empty array is returned.\n\nTo return deleted identities, `DELETED` status must be supplied explicitly for `statuses` query param.";
          querystring: TObject<
              {
                  amlVerificationStatuses: TOptional<TString>;
                  countriesOfResidence: TOptional<TString>;
                  createdAfter: TOptional<TString>;
                  createdBefore: TOptional<TString>;
                  emailLike: TOptional<TString>;
                  emails: TOptional<TString>;
                  hasCustomerVerification: TOptional<TBoolean>;
                  identityDocumentVerificationStatuses: TOptional<TString>;
                  ids: TOptional<TString>;
                  nameLike: TOptional<TString>;
                  orderBy: TOptional<TString>;
                  page: TOptional<TInteger>;
                  pageSize: TOptional<TInteger>;
                  phoneLike: TOptional<TString>;
                  phones: TOptional<TString>;
                  referenceIdLike: TOptional<TString>;
                  referenceIds: TOptional<TString>;
                  statuses: TOptional<TString>;
                  updatedAfter: TOptional<TString>;
                  updatedBefore: TOptional<TString>;
              },
          >;
          response: {
              "200": TObject<
                  {
                      hasNext: TBoolean;
                      items: TArray<
                          TObject<
                              {
                                  amlVerification: TOptional<TObject<(...)>>;
                                  countryOfResidence: TString;
                                  createdAt: TString;
                                  customerVerification: TOptional<TObject<(...)>>;
                                  dateOfBirth: TOptional<TString>;
                                  deletedAt: TOptional<TString>;
                                  email: TString;
                                  id: TString;
                                  identityDocumentVerification: TOptional<TObject<(...)>>;
                                  name: TOptional<TObject<(...)>>;
                                  phone: TString;
                                  referenceId: TOptional<TString>;
                                  status: TUnsafe<(...) | (...) | (...) | (...) | (...) | (...)>;
                                  updatedAt: TString;
                              },
                          >,
                      >;
                  },
              >;
          };
          summary: "Search for identities";
          tags: readonly ["Identity"];
      };
      post: {
          body: TIntersect<
              [
                  TObject<
                      {
                          countryOfResidence: TString;
                          customerVerification: TOptional<TObject<{ id: TString }>>;
                          email: TString;
                          phone: TString;
                          referenceId: TOptional<TString>;
                      },
                  >,
                  TObject<
                      {
                          dateOfBirth: TString;
                          name: TObject<
                              {
                                  firstName: TString;
                                  lastName: TString;
                                  middleName: TOptional<TString>;
                              },
                          >;
                      },
                  >,
              ],
          >;
          description: "An individual/person must be registered and verified as an identity before it can perform transactions on this platform.\n\nIf you have an agreement to verify an identity yourself, please provide `customerVerification`. Otherwise, a KYC process will be initiated for this identity.\nThe identity will remain in `PENDING_VERIFICATION` until the compliance checks have successfully completed.";
          response: {
              "201": TObject<
                  {
                      amlVerification: TOptional<
                          TObject<{ status: TUnsafe<(...) | (...) | (...) | (...)> }>,
                      >;
                      countryOfResidence: TString;
                      createdAt: TString;
                      customerVerification: TOptional<TObject<{ id: TString }>>;
                      dateOfBirth: TOptional<TString>;
                      deletedAt: TOptional<TString>;
                      email: TString;
                      id: TString;
                      identityDocumentVerification: TOptional<
                          TObject<{ status: TUnsafe<(...) | (...) | (...) | (...)> }>,
                      >;
                      name: TOptional<
                          TObject<
                              {
                                  firstName: TString;
                                  lastName: TString;
                                  middleName: TOptional<TString>;
                              },
                          >,
                      >;
                      phone: TString;
                      referenceId: TOptional<TString>;
                      status: TUnsafe<
                          | "ACTIVE"
                          | "DISABLED"
                          | "PENDING_VERIFICATION"
                          | "BLOCKED"
                          | "DELETED"
                          | "REVIEW",
                      >;
                      updatedAt: TString;
                  },
              >;
              "400": TUnion<
                  [
                      TUnion<
                          [
                              TObject<{ code: TLiteral<(...)>; message: TString }>,
                              TObject<{ code: TLiteral<(...)>; message: TString }>,
                              TObject<{ code: TLiteral<(...)>; message: TString }>,
                              TObject<{ code: TLiteral<(...)>; message: TString }>,
                              TIntersect<[TObject<(...)>, TObject<(...)>]>,
                          ],
                      >,
                      TObject<{ code: TLiteral<"CANNOT_BYO_KYC">; message: TString }>,
                      TObject<{ code: TLiteral<"PRODUCT_INACTIVE">; message: TString }>,
                  ],
              >;
          };
          summary: "Create a new identity";
          tags: readonly ["Identity"];
      };
  }

• Readonly/v1/identity/{id}: {
      delete: {
          description: "You can no longer use a deleted identity to transact. However, you can still retrieve it by ID.";
          params: TObject<{ id: TString }>;
          response: {
              "200": TObject<
                  {
                      amlVerification: TOptional<
                          TObject<{ status: TUnsafe<(...) | (...) | (...) | (...)> }>,
                      >;
                      countryOfResidence: TString;
                      createdAt: TString;
                      customerVerification: TOptional<TObject<{ id: TString }>>;
                      dateOfBirth: TOptional<TString>;
                      deletedAt: TOptional<TString>;
                      email: TString;
                      id: TString;
                      identityDocumentVerification: TOptional<
                          TObject<{ status: TUnsafe<(...) | (...) | (...) | (...)> }>,
                      >;
                      name: TOptional<
                          TObject<
                              {
                                  firstName: TString;
                                  lastName: TString;
                                  middleName: TOptional<TString>;
                              },
                          >,
                      >;
                      phone: TString;
                      referenceId: TOptional<TString>;
                      status: TUnsafe<
                          | "ACTIVE"
                          | "DISABLED"
                          | "PENDING_VERIFICATION"
                          | "BLOCKED"
                          | "DELETED"
                          | "REVIEW",
                      >;
                      updatedAt: TString;
                  },
              >;
              "404": TObject<{ code: TLiteral<"NOT_FOUND">; message: TString }>;
          };
          summary: "Delete an identity";
          tags: readonly ["Identity"];
      };
      get: {
          params: TObject<{ id: TString }>;
          response: {
              "200": TObject<
                  {
                      amlVerification: TOptional<
                          TObject<{ status: TUnsafe<(...) | (...) | (...) | (...)> }>,
                      >;
                      countryOfResidence: TString;
                      createdAt: TString;
                      customerVerification: TOptional<TObject<{ id: TString }>>;
                      dateOfBirth: TOptional<TString>;
                      deletedAt: TOptional<TString>;
                      email: TString;
                      id: TString;
                      identityDocumentVerification: TOptional<
                          TObject<{ status: TUnsafe<(...) | (...) | (...) | (...)> }>,
                      >;
                      name: TOptional<
                          TObject<
                              {
                                  firstName: TString;
                                  lastName: TString;
                                  middleName: TOptional<TString>;
                              },
                          >,
                      >;
                      phone: TString;
                      referenceId: TOptional<TString>;
                      status: TUnsafe<
                          | "ACTIVE"
                          | "DISABLED"
                          | "PENDING_VERIFICATION"
                          | "BLOCKED"
                          | "DELETED"
                          | "REVIEW",
                      >;
                      updatedAt: TString;
                  },
              >;
              "404": TObject<{ code: TLiteral<"NOT_FOUND">; message: TString }>;
          };
          summary: "Get an identity";
          tags: readonly ["Identity"];
      };
      patch: {
          body: TObject<
              {
                  customerVerification: TOptional<TObject<{ id: TString }>>;
                  dateOfBirth: TOptional<TString>;
                  email: TOptional<TString>;
                  phone: TOptional<TString>;
                  referenceId: TOptional<TString>;
                  status: TOptional<TUnsafe<"ACTIVE" | "DISABLED">>;
              },
          >;
          params: TObject<{ id: TString }>;
          response: {
              "200": TObject<
                  {
                      amlVerification: TOptional<
                          TObject<{ status: TUnsafe<(...) | (...) | (...) | (...)> }>,
                      >;
                      countryOfResidence: TString;
                      createdAt: TString;
                      customerVerification: TOptional<TObject<{ id: TString }>>;
                      dateOfBirth: TOptional<TString>;
                      deletedAt: TOptional<TString>;
                      email: TString;
                      id: TString;
                      identityDocumentVerification: TOptional<
                          TObject<{ status: TUnsafe<(...) | (...) | (...) | (...)> }>,
                      >;
                      name: TOptional<
                          TObject<
                              {
                                  firstName: TString;
                                  lastName: TString;
                                  middleName: TOptional<TString>;
                              },
                          >,
                      >;
                      phone: TString;
                      referenceId: TOptional<TString>;
                      status: TUnsafe<
                          | "ACTIVE"
                          | "DISABLED"
                          | "PENDING_VERIFICATION"
                          | "BLOCKED"
                          | "DELETED"
                          | "REVIEW",
                      >;
                      updatedAt: TString;
                  },
              >;
              "400": TUnion<
                  [
                      TUnion<
                          [
                              TObject<{ code: TLiteral<(...)>; message: TString }>,
                              TObject<{ code: TLiteral<(...)>; message: TString }>,
                              TObject<{ code: TLiteral<(...)>; message: TString }>,
                              TObject<{ code: TLiteral<(...)>; message: TString }>,
                              TIntersect<[TObject<(...)>, TObject<(...)>]>,
                          ],
                      >,
                      TObject<{ code: TLiteral<"CANNOT_BYO_KYC">; message: TString }>,
                      TObject<{ code: TLiteral<"INVALID_STATUS">; message: TString }>,
                      TObject<{ code: TLiteral<"MISSING_NAME">; message: TString }>,
                      TObject<{ code: TLiteral<"CANNOT_UPDATE_NAME">; message: TString }>,
                  ],
              >;
              "404": TObject<{ code: TLiteral<"NOT_FOUND">; message: TString }>;
          };
          summary: "Update an identity";
          tags: readonly ["Identity"];
      };
  }

• Readonly/v1/identity/{id}/verification-url: {
      post: {
          body: TObject<{ redirectUrl: TString }>;
          description: "This URL can be send to a person to fill out. Currently, the verification only covers identity documents.";
          params: TObject<{ id: TString }>;
          response: {
              "200": TObject<{ url: TString }>;
              "400": TUnion<
                  [TObject<{ code: TLiteral<"NOT_VERIFIED">; message: TString }>],
              >;
              "404": TObject<{ code: TLiteral<"NOT_FOUND">; message: TString }>;
          };
          summary: "Get the verification URL for an identity";
          tags: readonly ["Identity"];
      };
  }