v1

latestOpenAPI 3.0.02026-07-1427437.7 KB

Profiles

Create client profile

Creates new client profile.

Since your store's profile schema is customizable, the schema and examples presented below may differ from yours. Your integration must be adapted accordingly.

The id field returned by this request is the profileId used to retrieve information on a specific profile later.

Learn more about the Profile System and its other API endpoints.

post/api/storage/profile-system/profiles

Query parameters

ttlinteger

Example:365

This parameter sets the the Time To Live (TTL), in days, of the specific document being created or updated with this request. After this period of time from the moment of the request, the document is deleted. By sending this parameter you override the TTL set for the schema.

Currently, the available default document schemas have no TTL. This means that documents are stored indefinitely, unless a TTL is sent when creating or updating.

Headers

Content-Typestring required

Example:application/json

Type of the content being sent.

Acceptstring required

Example:application/json

HTTP Client Negotiation Accept Header. Indicates the types of responses the client can understand.

Request body

birthDatestring

Client's birth date in ISO 8601 format.

documentstring required

Client's document.

documentTypestring required

Type of document informed in document.

emailstring required

Client's email address.

firstNamestring required

Client's first name.

lastNamestring required

Client's last name.

Example request

{
  "birthDate": "1925-11-17",
  "document": "12345678900",
  "documentType": "CPF",
  "email": "john.doe@example.com",
  "firstName": "John",
  "lastName": "Doe"
}

Response

Created

object required

All 27 operations