Credify API (1.1.0)

Credify API Specifications

Auth

Obtain access token

returns access token required for other APIs.

Request Body schema: application/json

email	string
password	string

Responses

Request samples

Payload

Content type

application/json

{"email": "joe@example.com",
"password": "123456789"
}

Response samples

200
401

Content type

application/json

{"access_token": "string",
"refresh_token": "string",
"user_id": 0,
"email": "user@example.com"
}

Users

Users to score their credit

Users list

Returns a list of company users.

Authorizations:

BearerAuth

path Parameters

search	string Search for a user by their `user_id`, `email`, or `phone`.
page	number Example: 1
size	number Example: 10
createdAfter	string Example: 2019-08-24T14:15:22Z

Responses

Response samples

200
401

Content type

application/json

[{"user_id": "usr_abc123",
"permissions_status": "granted",
"user_name": "string",
"user_phone": "string",
"last_updated": "2019-08-24T14:15:22Z",
"created_at": "2019-08-24T14:15:22Z"
}
]

User

Returns user object.

Authorizations:

BearerAuth

path Parameters

userId

required

string

Unique identifier of the user

Responses

Response samples

200
401

Content type

application/json

{"user_id": "usr_abc123",
"permissions_status": "granted",
"user_name": "string",
"user_phone": "string",
"last_updated": "2019-08-24T14:15:22Z",
"created_at": "2019-08-24T14:15:22Z"
}

Transactions

Transactions represent the financial money movement to and from user accounts.

User Transactions

Returns transactions for a user.

Authorizations:

BearerAuth

path Parameters

userId

required

string

Unique identifier of the user

query Parameters

startTimestamp

integer

Restricts the returned transactions to only include transaction after the specified startTimestamp.

Responses

Response samples

200
401

Content type

application/json

[{"id": 1,
"user_id": "usr_abc123",
"account_type": "credit_limit",
"amount": "1000",
"timestamp": 1627876482,
"event": "event",
"transaction_type": "type",
"amount_currency": "USD",
"balance": "1000",
"balance_currency": "USD",
"institution_name": "CIB"
}
]

User Transactions Summary

Returns a summary of user transactions.

Authorizations:

BearerAuth

path Parameters

userId

required

string

Unique identifier of the user

Responses

Response samples

200
401

Content type

application/json

{"months": [{"institution_name": "Bank of America",
"account_type": "Checking",
"month": 1,
"total_debit": 1000,
"total_credit": 1000,
"salary": 1000,
"balance": 1000
}
],
"averages": [{"institution_name": "Bank of America",
"account_type": "Checking",
"average_salary": 1000,
"average_cash_in": 500,
"average_cash_out": 500
}
]
}

Flags

Flags represent user financial activity that worth noticing regarding their credit scoring

User Flags

Returns flags for a user.

Authorizations:

BearerAuth

path Parameters

userId

required

string

Unique identifier of the user

Responses

Response samples

200
401

Content type

application/json

[{"id": "12345",
"user_id": "user_001",
"institution_name": "CIB",
"flag_label": "suspicious_activity",
"timestamp": 1627876482
}
]

User Flags Summary

Returns a summary of user flags.

Authorizations:

BearerAuth

path Parameters

userId

required

string

Unique identifier of the user

Responses

Response samples

200
401

Content type

application/json

{"months": [{"month": 0,
"flag_label": "string",
"institution_name": "string",
"account_type": "string",
"count": 0
}
]
}

Features

Features represent a calculations based on user transactions and flags to score their credit

Features

Returns features for user.

Authorizations:

BearerAuth

path Parameters

userId

required

string

Unique identifier of the user

query Parameters

integer or string

either a timestamp or a date (YYYY-MM-DD).

Responses

Response samples

200
401

Content type

application/json

{"user_id": "string",
"count_of_airtime_purchase_events_0_30": 0,
"count_of_airtime_purchase_events_0_60": 0,
"count_of_airtime_purchase_events_0_90": 0,
"count_of_airtime_purchase_events_30_60": 0,
"count_of_airtime_purchase_events_60_90": 0,
"count_of_repayment_reminder_0_30": 0,
"count_of_repayment_warning_0_60": 0,
"count_of_repayment_reminder_0_60": 0,
"count_of_repayment_warning_0_90": 0,
"count_of_repayment_reminder_0_90": 0,
"count_of_repayment_warning_30_60": 0
}