Deprecated API Reference

This API Reference is being deprecated. Please use the New API Reference.

List All Identities

List all of the Identity resources that have been created.

Copy
Copied
curl https://finix.sandbox-payments-api.com/identities/ \
    -H "Content-Type: application/json" \
    -H 'Finix-Version: 2022-02-01' \
    -u  USsRhsHYZGBPnQw8CByJyEQW:8a14c2f9-d94b-4c72-8f5c-a62908e5b30e

Example Response:

Copy
Copied
{
  "_embedded" : {
    "identities" : [ {
      "id" : "IDnUtHdRgvhAurYujebrfpWa",
      "created_at" : "2022-10-07T20:43:00.06Z",
      "updated_at" : "2022-10-07T20:43:00.06Z",
      "application" : "APgPDQrLD52TYvqazjHJJchM",
      "entity" : {
        "amex_mid" : null,
        "annual_card_volume" : 12000000,
        "business_address" : {
          "line1" : "741 Douglass St",
          "line2" : "Apartment 8",
          "city" : "San Mateo",
          "region" : "CA",
          "postal_code" : "94114",
          "country" : "USA"
        },
        "business_name" : "Finix Flowers",
        "business_phone" : "+1 (408) 756-4497",
        "business_tax_id_provided" : true,
        "business_type" : "INDIVIDUAL_SOLE_PROPRIETORSHIP",
        "default_statement_descriptor" : "Finix Flowers",
        "discover_mid" : null,
        "dob" : {
          "day" : 27,
          "month" : 6,
          "year" : 1978
        },
        "doing_business_as" : "Finix Flowers",
        "email" : "user@example.org",
        "first_name" : "John",
        "has_accepted_credit_cards_previously" : true,
        "incorporation_date" : {
          "day" : 27,
          "month" : 6,
          "year" : 1978
        },
        "last_name" : "Smith",
        "max_transaction_amount" : 12000000,
        "mcc" : "4900",
        "ownership_type" : "PRIVATE",
        "personal_address" : {
          "line1" : "741 Douglass St",
          "line2" : "Apartment 7",
          "city" : "San Mateo",
          "region" : "CA",
          "postal_code" : "94114",
          "country" : "USA"
        },
        "phone" : "1234567890",
        "principal_percentage_ownership" : 50,
        "short_business_name" : null,
        "tax_authority" : null,
        "tax_id_provided" : true,
        "title" : "CEO",
        "url" : "www.Finix.com"
      },
      "tags" : {
        "Studio Rating" : "4.7"
      },
      "_links" : {
        "self" : {
          "href" : "https://finix.sandbox-payments-api.com/identities/IDnUtHdRgvhAurYujebrfpWa"
        },
        "application" : {
          "href" : "https://finix.sandbox-payments-api.com/applications/APgPDQrLD52TYvqazjHJJchM"
        },
        "verifications" : {
          "href" : "https://finix.sandbox-payments-api.com/identities/IDnUtHdRgvhAurYujebrfpWa/verifications"
        },
        "merchants" : {
          "href" : "https://finix.sandbox-payments-api.com/identities/IDnUtHdRgvhAurYujebrfpWa/merchants"
        },
        "settlements" : {
          "href" : "https://finix.sandbox-payments-api.com/identities/IDnUtHdRgvhAurYujebrfpWa/settlements{?requestParams}",
          "templated" : true
        },
        "authorizations" : {
          "href" : "https://finix.sandbox-payments-api.com/identities/IDnUtHdRgvhAurYujebrfpWa/authorizations"
        },
        "transfers" : {
          "href" : "https://finix.sandbox-payments-api.com/identities/IDnUtHdRgvhAurYujebrfpWa/transfers"
        },
        "payment_instruments" : {
          "href" : "https://finix.sandbox-payments-api.com/identities/IDnUtHdRgvhAurYujebrfpWa/payment_instruments"
        },
        "associated_identities" : {
          "href" : "https://finix.sandbox-payments-api.com/identities/IDnUtHdRgvhAurYujebrfpWa/associated_identities"
        },
        "disputes" : {
          "href" : "https://finix.sandbox-payments-api.com/identities/IDnUtHdRgvhAurYujebrfpWa/disputes"
        }
      }
    }, {
      "id" : "IDgZEm2La6ut6vHDR8zqdDaK",
      "created_at" : "2022-09-26T23:21:12.34Z",
      "updated_at" : "2022-09-26T23:21:12.34Z",
      "application" : "APgPDQrLD52TYvqazjHJJchM",
      "entity" : {
        "amex_mid" : null,
        "annual_card_volume" : 0,
        "business_address" : null,
        "business_name" : null,
        "business_phone" : null,
        "business_tax_id_provided" : false,
        "business_type" : null,
        "default_statement_descriptor" : null,
        "discover_mid" : null,
        "dob" : null,
        "doing_business_as" : null,
        "email" : "user@example.org",
        "first_name" : "John",
        "has_accepted_credit_cards_previously" : false,
        "incorporation_date" : null,
        "last_name" : "Smith",
        "max_transaction_amount" : 0,
        "mcc" : null,
        "ownership_type" : null,
        "personal_address" : {
          "line1" : "741 Douglass St",
          "line2" : "Apartment 7",
          "city" : "San Mateo",
          "region" : "CA",
          "postal_code" : "94114",
          "country" : "USA"
        },
        "phone" : "7145677613",
        "principal_percentage_ownership" : null,
        "short_business_name" : null,
        "tax_authority" : null,
        "tax_id_provided" : false,
        "title" : null,
        "url" : null
      },
      "tags" : { },
      "_links" : {
        "self" : {
          "href" : "https://finix.sandbox-payments-api.com/identities/IDgZEm2La6ut6vHDR8zqdDaK"
        },
        "application" : {
          "href" : "https://finix.sandbox-payments-api.com/applications/APgPDQrLD52TYvqazjHJJchM"
        },
        "verifications" : {
          "href" : "https://finix.sandbox-payments-api.com/identities/IDgZEm2La6ut6vHDR8zqdDaK/verifications"
        },
        "merchants" : {
          "href" : "https://finix.sandbox-payments-api.com/identities/IDgZEm2La6ut6vHDR8zqdDaK/merchants"
        },
        "settlements" : {
          "href" : "https://finix.sandbox-payments-api.com/identities/IDgZEm2La6ut6vHDR8zqdDaK/settlements{?requestParams}",
          "templated" : true
        },
        "authorizations" : {
          "href" : "https://finix.sandbox-payments-api.com/identities/IDgZEm2La6ut6vHDR8zqdDaK/authorizations"
        },
        "transfers" : {
          "href" : "https://finix.sandbox-payments-api.com/identities/IDgZEm2La6ut6vHDR8zqdDaK/transfers"
        },
        "payment_instruments" : {
          "href" : "https://finix.sandbox-payments-api.com/identities/IDgZEm2La6ut6vHDR8zqdDaK/payment_instruments"
        },
        "associated_identities" : {
          "href" : "https://finix.sandbox-payments-api.com/identities/IDgZEm2La6ut6vHDR8zqdDaK/associated_identities"
        },
        "disputes" : {
          "href" : "https://finix.sandbox-payments-api.com/identities/IDgZEm2La6ut6vHDR8zqdDaK/disputes"
        }
      }
    } ]
  },
  "_links" : {
    "self" : {
      "href" : "https://finix.sandbox-payments-api.com/identities/"
    },
    "next" : {
      "href" : "https://finix.sandbox-payments-api.com/identities/?after_cursor=IDgZEm2La6ut6vHDR8zqdDaK"
    }
  },
  "page" : {
    "limit" : 100,
    "next_cursor" : "IDgZEm2La6ut6vHDR8zqdDaK"
  }
}

HTTP Request

GET https://finix.sandbox-payments-api.com/identities/