Create a Transaction

This endpoint facilitates the generation of a new transaction using the POST method. For further details, please have a look at the various responses below:

Create a Transaction - Success

You will get the following successful response with the generated verification link and the transaction_id:

{
    "transaction_id": "your_transaction_id",
    "url": "https://example.au.idkit.com/transaction_id",
    "expires_at": "2022-04-27T09:48:10.466Z"
}

Create a Transaction - Error

When the server can't understand the request due to invalid syntax, it will return the following error response:

{
  "error_message": "Bad Request."
}

The following error response is generated if an invalid or expired access token is used:

{
  "error_message": "Unauthenticated."
}

When the server encounters a situation it doesn't know how to handle, the following error response will appear:

{
  "error_message": "Internal Server Error."
}

The following table explains all the possible fields in both success and error responses.

Fields	Data Type	Mandatory/Optional	Description
`transaction_id`	string	Mandatory	The transaction ID, a unique identifier of every transaction.
`url`	URL	Mandatory	The transaction URL, which will redirect the user to the IDKit verification process.
`expires_at`	string	Mandatory	The timestamp at which the transaction will expire. Normally it is 7 days from the creation.
`error_message`	string	Optional	The error message, depicting what the error actually is, for example, "Unauthenticated."

💬 We Are Here to Help!

If you encounter an issue, a bug, or require assistance, please contact our support page here to find the solution. Don't forget to provide any important information on the issue.