Consumer Cases API

Consumer cases are resources representing individuals undergoing KYC (Know Your Customer) verification in the GridLogs platform. This API allows you to create, retrieve, update, and delete consumer cases.

Create Consumer Case

POST /v1/consumer-cases

Creates a new consumer case.

Request

string

required

Email address of the consumer

firstName

string

First name of the consumer

lastName

string

Last name of the consumer

phoneNumber

string

Phone number of the consumer

dateOfBirth

string

Date of birth in ISO format (YYYY-MM-DD)

nationality

string

Nationality of the consumer

Response

string

Unique identifier for the consumer case

string

Email address of the consumer

firstName

string

First name of the consumer

lastName

string

Last name of the consumer

phoneNumber

string

Phone number of the consumer

dateOfBirth

string

Date of birth in ISO format

nationality

string

Nationality of the consumer

status

string

Status of the consumer case

createdAt

string

Creation timestamp

updatedAt

string

Last update timestamp

Examples

curl -X POST https://api.gridlogs.co/v1/consumer-cases \
  -H "X-API-Key: your_api_key_here" \
  -H "Content-Type: application/json" \
  -d '{
    "email": "john.doe@example.com",
    "firstName": "John",
    "lastName": "Doe",
    "phoneNumber": "+14155552671",
    "dateOfBirth": "1980-01-01",
    "nationality": "US"
  }'

List Consumer Cases

GET /v1/consumer-cases

Returns a paginated list of consumer cases.

Query Parameters

page

number

Page number for pagination (default: 1)

limit

number

Number of items per page (default: 10)

status

string

Filter by status

string

Search term to filter results

Response

items

array

Array of consumer case objects

Examples

curl -X GET "https://api.gridlogs.co/v1/consumer-cases?page=1&limit=10&status=ACTIVE" \
  -H "X-API-Key: your_api_key_here"

Get Consumer Case

GET /v1/consumer-cases/{id}

Retrieves a specific consumer case by ID.

Path Parameters

string

required

Consumer case ID

Response

Returns a consumer case object with all its properties.

Examples

curl -X GET "https://api.gridlogs.co/v1/consumer-cases/cc_12345" \
  -H "X-API-Key: your_api_key_here"

Update Consumer Case

PATCH /v1/consumer-cases/{id}

Updates a specific consumer case.

Path Parameters

string

required

Consumer case ID

Request

string

Email address of the consumer

firstName

string

First name of the consumer

lastName

string

Last name of the consumer

phoneNumber

string

Phone number of the consumer

dateOfBirth

string

Date of birth in ISO format (YYYY-MM-DD)

nationality

string

Nationality of the consumer

status

string

Status of the consumer case

Response

Returns the updated consumer case object.

Examples

curl -X PATCH "https://api.gridlogs.co/v1/consumer-cases/cc_12345" \
  -H "X-API-Key: your_api_key_here" \
  -H "Content-Type: application/json" \
  -d '{
    "firstName": "John Updated",
    "lastName": "Doe Updated",
    "status": "VERIFIED"
  }'

Delete Consumer Case

DELETE /v1/consumer-cases/{id}

Deletes a specific consumer case.

Path Parameters

string

required

Consumer case ID

Response

Returns the deleted consumer case object.

Examples

curl -X DELETE "https://api.gridlogs.co/v1/consumer-cases/cc_12345" \
  -H "X-API-Key: your_api_key_here"

Get Onboarding Form By Token

GET /v1/consumer-cases/onboarding/{token}

Retrieves a consumer onboarding form by its token.

Path Parameters

token

string

required

Onboarding form token

Response

Returns the consumer onboarding form object.

Examples

curl -X GET "https://api.gridlogs.co/v1/consumer-cases/onboarding/abc123xyz" \
  -H "X-API-Key: your_api_key_here"

Send Onboarding Email

POST /v1/consumer-cases/onboarding/send-email

Sends an onboarding email with a link to the consumer onboard page.

Request

fullName

string

required

Full name of the consumer

string

required

Email address to send the onboarding link to

from

string

Email address to send from (defaults to “verification@gridlogs.com”)

senderCompanyName

string

Name of the sending company (defaults to “Gridlogs”)

Response

success

boolean

Whether the email was sent successfully

token

string

The onboarding token generated

Examples

curl -X POST "https://api.gridlogs.co/v1/consumer-cases/onboarding/send-email" \
  -H "X-API-Key: your_api_key_here" \
  -H "Content-Type: application/json" \
  -d '{
    "fullName": "John Doe",
    "email": "john.doe@example.com",
    "from": "verification@mycompany.com",
    "senderCompanyName": "My Company"
  }'

​Consumer Cases API

​Create Consumer Case

​Request

​Response

​Examples

​List Consumer Cases

​Query Parameters

​Response

​Examples

​Get Consumer Case

​Path Parameters

​Response

​Examples

​Update Consumer Case

​Path Parameters

​Request

​Response

​Examples

​Delete Consumer Case

​Path Parameters

​Response

​Examples

​Get Onboarding Form By Token

​Path Parameters

​Response

​Examples

​Send Onboarding Email

​Request

​Response

​Examples

Consumer Cases API

Create Consumer Case

Request

Response

Examples

List Consumer Cases

Query Parameters

Response

Examples

Get Consumer Case

Path Parameters

Response

Examples

Update Consumer Case

Path Parameters

Request

Response

Examples

Delete Consumer Case

Path Parameters

Response

Examples

Get Onboarding Form By Token

Path Parameters

Response

Examples

Send Onboarding Email

Request

Response

Examples