Identities

Create an Identity

Changed on

Create an Identity for your Buyer, Recipient, or Seller, using identity_roles and type to indicate the type of Identity you're creating.

Related Guides: Getting Started, Onboarding

post/identities

Request

Headers

Finix-Versionstring
Example:2022-02-01

Specify the API version of your request. For more details, see Versioning.

Content-Typestring
Example:application/json

The data type being sent in the request body must be application/json.

Request body

OR
OR
OR
OR
OR
OR
OR

Response

Single Identity object

idstring

The ID of the resource.

created_atstring date-time

Timestamp of when the object was created.

updated_atstring date-time

Timestamp of when the object was last updated.

applicationstring

ID of the Application associated with the resource.

identity_rolesstring[]

The set of roles available to the Identity. If none is provided, the Identity will be assigned BUYER.

type'PERSONAL' | 'BUSINESS'

The Identity type.

tagsTags nullable

Include up to 50 key: value pairs to annotate requests with custom metadata.

  • Maximum character length for individual keys is 40.
  • Maximum character length for individual values is 500. (For example, order_number: 25, item_type: produce, department: sales)

Changes

    • info

      added to the request body oneOf list

    • breaking

      the response property / became nullable for the status

    • breaking

      the / response's property type changed from no type to object for status

    • info

      added the new optional request property //

    • info

      the request property /// became nullable

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      removed from the / response property allOf list for the response status

    • info

      added the required property // to the response with the status

    • info

      added the required property // to the response with the status

    • info

      added the required property // to the response with the status

    • info

      added the required property // to the response with the status

    • info

      added the required property // to the response with the status