Variable organizationApiConst

Type Declaration

• Readonly/v1/organization: {
      get: {
          description: "Search to retrieve organizations associated with the provided customer `referenceId`.";
          querystring: TObject<{ referenceId: TString }>;
          response: {
              "200": TObject<
                  {
                      address: TOptional<
                          TObject<
                              {
                                  city: TString;
                                  countryCode: TString;
                                  line1: TString;
                                  line2: TOptional<TString>;
                                  postalCode: TString;
                                  region: TOptional<TString>;
                              },
                          >,
                      >;
                      countryOfIncorporation: TString;
                      createdAt: TOptional<TString>;
                      description: TOptional<TString>;
                      email: TOptional<TString>;
                      id: TString;
                      legalEntityType: TString;
                      name: TString;
                      phone: TOptional<TString>;
                      referenceId: TOptional<TString>;
                      status: TUnsafe<"ACTIVE" | "DISABLED" | "PENDING_VERIFICATION">;
                      taxId: TString;
                      updatedAt: TOptional<TString>;
                      websiteUrl: TOptional<TString>;
                  },
              >;
              "404": TObject<{ code: TLiteral<"NOT_FOUND">; message: TString }>;
          };
          summary: "Search Organizations";
          tags: readonly ["Organization"];
      };
      post: {
          body: TIntersect<
              [
                  TObject<
                      {
                          countryOfIncorporation: TString;
                          description: TOptional<TString>;
                          email: TOptional<TString>;
                          legalEntityType: TString;
                          name: TString;
                          phone: TOptional<TString>;
                          referenceId: TOptional<TString>;
                          taxId: TString;
                          websiteUrl: TOptional<TString>;
                      },
                  >,
                  TObject<
                      {
                          address: TObject<
                              {
                                  city: TString;
                                  countryCode: TString;
                                  line1: TString;
                                  line2: TOptional<TString>;
                                  postalCode: TString;
                                  region: TOptional<TString>;
                              },
                          >;
                      },
                  >,
              ],
          >;
          description: "Register an Organization within the CFX platform. Organizations must provide an Employer Identification Number (EIN).";
          response: {
              "201": TObject<
                  {
                      address: TOptional<
                          TObject<
                              {
                                  city: TString;
                                  countryCode: TString;
                                  line1: TString;
                                  line2: TOptional<TString>;
                                  postalCode: TString;
                                  region: TOptional<TString>;
                              },
                          >,
                      >;
                      countryOfIncorporation: TString;
                      createdAt: TOptional<TString>;
                      description: TOptional<TString>;
                      email: TOptional<TString>;
                      id: TString;
                      legalEntityType: TString;
                      name: TString;
                      phone: TOptional<TString>;
                      referenceId: TOptional<TString>;
                      status: TUnsafe<"ACTIVE" | "DISABLED" | "PENDING_VERIFICATION">;
                      taxId: TString;
                      updatedAt: TOptional<TString>;
                      websiteUrl: TOptional<TString>;
                  },
              >;
              "400": TUnion<
                  [
                      TObject<{ code: TLiteral<"INVALID_PHONE">; message: TString }>,
                      TObject<{ code: TLiteral<"INVALID_EMAIL">; message: TString }>,
                      TObject<{ code: TLiteral<"INVALID_WEBSITE_URL">; message: TString }>,
                      TObject<{ code: TLiteral<"DUPLICATE">; message: TString }>,
                      TObject<{ code: TLiteral<"PRODUCT_INACTIVE">; message: TString }>,
                  ],
              >;
          };
          summary: "Register Organization";
          tags: readonly ["Organization"];
      };
  }

• Readonly/v1/organization/{id}/verification-url: {
      post: {
          body: TObject<{ redirectUrl: TString }>;
          description: "This URL can be sent to an organization to fill out.";
          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 organization";
          tags: readonly ["Organization"];
      };
  }

• Readonly/v1/organization/{organizationId}: {
      delete: {
          description: "Delete an organization.";
          params: TObject<{ organizationId: TString }>;
          response: {
              "200": TObject<{ message: TString }>;
              "404": TObject<{ code: TLiteral<"NOT_FOUND">; message: TString }>;
          };
          summary: "Delete Organization";
          tags: readonly ["Organization"];
      };
      get: {
          description: "Retrieve an organization by nominating a specific `organizationId`.";
          params: TObject<{ organizationId: TString }>;
          response: {
              "200": TObject<
                  {
                      address: TOptional<
                          TObject<
                              {
                                  city: TString;
                                  countryCode: TString;
                                  line1: TString;
                                  line2: TOptional<TString>;
                                  postalCode: TString;
                                  region: TOptional<TString>;
                              },
                          >,
                      >;
                      countryOfIncorporation: TString;
                      createdAt: TOptional<TString>;
                      description: TOptional<TString>;
                      email: TOptional<TString>;
                      id: TString;
                      legalEntityType: TString;
                      name: TString;
                      phone: TOptional<TString>;
                      referenceId: TOptional<TString>;
                      status: TUnsafe<"ACTIVE" | "DISABLED" | "PENDING_VERIFICATION">;
                      taxId: TString;
                      updatedAt: TOptional<TString>;
                      websiteUrl: TOptional<TString>;
                  },
              >;
              "404": TObject<{ code: TLiteral<"NOT_FOUND">; message: TString }>;
          };
          summary: "Get Organization";
          tags: readonly ["Organization"];
      };
      patch: {
          body: TObject<
              {
                  address: TOptional<
                      TObject<
                          {
                              city: TString;
                              countryCode: TString;
                              line1: TString;
                              line2: TOptional<TString>;
                              postalCode: TString;
                              region: TOptional<TString>;
                          },
                      >,
                  >;
                  countryOfIncorporation: TOptional<TString>;
                  description: TOptional<TString>;
                  email: TOptional<TString>;
                  legalEntityType: TOptional<TString>;
                  phone: TOptional<TString>;
                  referenceId: TOptional<TString>;
                  taxId: TOptional<TString>;
                  websiteUrl: TOptional<TString>;
              },
          >;
          description: "Update an organization.";
          params: TObject<{ organizationId: TString }>;
          response: {
              "200": TObject<
                  {
                      address: TOptional<
                          TObject<
                              {
                                  city: TString;
                                  countryCode: TString;
                                  line1: TString;
                                  line2: TOptional<TString>;
                                  postalCode: TString;
                                  region: TOptional<TString>;
                              },
                          >,
                      >;
                      countryOfIncorporation: TString;
                      createdAt: TOptional<TString>;
                      description: TOptional<TString>;
                      email: TOptional<TString>;
                      id: TString;
                      legalEntityType: TString;
                      name: TString;
                      phone: TOptional<TString>;
                      referenceId: TOptional<TString>;
                      status: TUnsafe<"ACTIVE" | "DISABLED" | "PENDING_VERIFICATION">;
                      taxId: TString;
                      updatedAt: TOptional<TString>;
                      websiteUrl: TOptional<TString>;
                  },
              >;
              "400": TUnion<
                  [
                      TObject<{ code: TLiteral<"INVALID_PHONE">; message: TString }>,
                      TObject<{ code: TLiteral<"INVALID_EMAIL">; message: TString }>,
                      TObject<{ code: TLiteral<"INVALID_WEBSITE_URL">; message: TString }>,
                      TObject<{ code: TLiteral<"DUPLICATE">; message: TString }>,
                      TObject<{ code: TLiteral<"PRODUCT_INACTIVE">; message: TString }>,
                  ],
              >;
              "404": TObject<{ code: TLiteral<"NOT_FOUND">; message: TString }>;
          };
          summary: "Update Organization";
          tags: readonly ["Organization"];
      };
  }