LinkCy

Sandbox

Initialize or reset a password with secret in response

Whether you want to initialize first password or reset a password, you should use this endpoint. Send a secret in response that can be used to change the password of the account.

SecurityLinkcy-Auth
Request
Request Body schema: application/json
required
Any of:
consumerPhone
required
string^[0-9]{2,17}$

The complete consumer's phone, including country code. Must not contain +.

partnerName
required
string
phone
required
string
Responses
200

OK

400

Bad Request

401

Unauthorized

403

Forbidden

post/api/partner/passwords/reset/sandbox
Request samples
application/json
{
  • "consumerPhone": "33123456789",
  • "partnerName": "string",
  • "phone": "string"
}
Response samples
application/json
{
  • "passwordChangeSecret": "string"
}

Credit a ledger

Used to simulate an external credit to a ledger, http errors are not yet handled/no validation. The amount can contain 2 decimal places and the maximum is 1000.

SecurityLinkcy-Auth
Request
Request Body schema: application/json
required
amount
required
number
ledgerId
required
string <uuid>
Responses
200

OK

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

409

Conflict

post/api/partner/ledgers/credit
Request samples
application/json
{
  • "amount": 0,
  • "ledgerId": "a2873d47-59a8-4daf-a325-cb2c04557dd7"
}
Response samples
application/json
{
  • "ledgerId": "a2873d47-59a8-4daf-a325-cb2c04557dd7",
  • "transactionId": "75906707-8c31-479c-b354-aa805c4cefbc"
}

Simulate a KYC result for a consumer or a corporate-related person

Simulate a KYC for a consumer or corporate related person with custom values.

The missing information will be automatically populated with default values.

SecurityLinkcy-Auth
Request
Request Body schema: application/json
required
Any of:
consumerId
string <uuid>

Id of the consumer doing the KYC (Will be ignored and deducted from current authenticated user if consumer)

kycStatus
required
string

The new KYC status

Enum: "NOT_STARTED" "CREATED" "PROCESSING" "PENDING_REVIEW" "ABORTED" … 2 more
object (EuropeanAddressRequest)
firstName
string [ 0 .. 255 ] characters
middleName
string [ 0 .. 255 ] characters
lastName
string [ 0 .. 255 ] characters
gender
string
Enum: "MALE" "FEMALE"
birthDate
string <date>
emailAddress
string
birthCity
string
birthIsoCountryCode
string
Enum: "ABW" "AFG" "AGO" "AIA" "ALA" … 240 more
nationalityCode
string
Enum: "ABW" "AFG" "AGO" "AIA" "ALA" … 240 more
Responses
201

Simulated KYC successfully created

400

Bad Request

401

Unauthorized

403

Forbidden

post/api/partner/kyc/simulate
Request samples
application/json
{
  • "consumerId": "9e675a24-20d6-4913-9836-f861cd23e89e",
  • "kycStatus": "NOT_STARTED",
  • "address": {
    },
  • "firstName": "string",
  • "middleName": "string",
  • "lastName": "string",
  • "gender": "MALE",
  • "birthDate": "2019-08-24",
  • "emailAddress": "string",
  • "birthCity": "string",
  • "birthIsoCountryCode": "ABW",
  • "nationalityCode": "ABW"
}
Response samples
application/json
{
  • "kycApplicationId": "79d915d9-9648-4a89-9125-d56b7a19df65",
  • "consumerId": "9e675a24-20d6-4913-9836-f861cd23e89e"
}

Delete a corporate

Delete a corporate by id. This endpoint allows you to try again the whole corporate creation flow.

SecurityLinkcy-Auth
Request
path Parameters
corporateId
required
string <uuid>
Responses
200

OK

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

delete/api/partner/corporates/{corporateId}
Request samples 
Response samples 
application/json
{
  • "status": 400,
  • "details": [
    ],
  • "error": "linkcy.bad.request",
  • "timestamp": "2019-08-24T14:15:22Z"
}
Manually bypass a corporate's KYB status
Used to update manually the KYB status of a corporate in order to try different use cases.


SecurityLinkcy-Auth 
Request 
path Parameters
corporateId
required
string <uuid> 
 
Request Body schema: application/json
required
kybStatus
required
string
The new KYB status


 Enum: "NOT_STARTED" "COMPLETING" "PENDING_VERIFICATION" "NEED_ADDITIONAL_INFORMATION" "DECLINED" … 1 more 
Responses 
200
OK


400
Bad Request


401
Unauthorized


403
Forbidden


404
Not Found


409
Conflict


patch/api/partner/corporates/{corporateId}/kyb
Request samples 
application/json
{
  • "kybStatus": "NOT_STARTED"
}
Response samples 
application/json
{
  • "corporateId": "50eb73c4-9d2f-4e30-9f0c-2d57c30a46ee"
}
Delete a consumer
Delete a consumer by id. This endpoint allows you to try again the whole consumer creation flow.


SecurityLinkcy-Auth 
Request 
path Parameters
consumerId
required
string <uuid> 
 
Responses 
200
OK


400
Bad Request


401
Unauthorized


403
Forbidden


404
Not Found


delete/api/partner/consumers/{consumerId}
Request samples 
Response samples 
application/json
{
  • "status": 400,
  • "details": [
    ],
  • "error": "linkcy.bad.request",
  • "timestamp": "2019-08-24T14:15:22Z"
}
Bypass a beneficiary's status
Allows you to manually set a beneficiary's status to VALID, useful for bypassing the current status if it was PENDING_REVIEW or DECLINED.


SecurityLinkcy-Auth 
Request 
path Parameters
beneficiaryId
required
string <uuid> 
 
Responses 
200
OK


400
Bad Request


401
Unauthorized


403
Forbidden


404
Not Found


patch/api/partner/beneficiaries/{beneficiaryId}/status
Request samples 
Response samples 
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}
Get a card truncated PAN
Used to get the truncated PAN of a card (that you will not receive) in order to activate it.


SecurityLinkcy-Auth 
Request 
path Parameters
cardId
required
string <uuid> 
 
Responses 
200
OK


400
Bad Request


401
Unauthorized


403
Forbidden


404
Not Found


409
Conflict


get/api/partner/cards/{cardId}/pan
Request samples 
Response samples 
application/json
"string"
➔ Next to Web Pages