Storefront KYC documents

Use these operations to access Storefront KYC documents.

Storefront operations interact directly with the customer, and provide the customer with access to their own data.

To use Storefront operations, the customer must be issued a JWT with limited permissions. For more information, see Create a session with username and password and Exchange an authentication token. Storefront operations are intended to be used directly from an untrusted browser.

Operations

Create a KYC document

Request

Creates a KYC document.

Security
CustomerJWT
Bodyapplication/jsonrequired

KYC document resource.

fileIdsArray of strings

IDs of linked file objects.

Uploaded identity-proof files must have the following tags attached to be used for KYC purposes: ['kyc', 'id-front'], ['kyc', 'id-back'], ['kyc', 'face-proof'].

Permitted file types for identity-proof files: .jpg, .png, and .pdf.

documentTypestring(StorefrontKycDocumentTypes)required

Document type submitted for validation. Only the identity-proof and address-proof types are analyzed automatically.

Enum:"identity-proof""address-proof""funds-proof""purchase-proof"
Discriminator
documentSubtypestring or null(KycDocumentSubtypes)

Document subtype submitted for validation.

Enum:"passport""id-card""driver-license""birth-certificate""utility-bill""rental-receipt""lease-agreement""copy-credit-card""credit-card-statement""bank-statement"
curl -i -X POST \
  https://www.rebilly.com/_mock/catalog/all/storefront/kyc-documents \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "id": "4f6cf35x-2c4y-483z-a0a9-158621f77a21",
    "fileIds": [
      "4f6cf35x-2c4y-483z-a0a9-158621f77a21"
    ],
    "documentType": "identity-proof",
    "documentSubtype": "passport"
  }'

Responses

KYC document created.

Headers
Locationstring, (uri)

Location of the related resource.

Example:"https://api.rebilly.com/example"
X-RateLimit-Limitinteger

Total number of rate limit tokens for this request within a rate limit period. For more information, see Rate limits.

Example:3600
X-RateLimit-Remaininginteger

Remaining number of rate limit tokens for this request within the rate limit period. For example, in the sandbox environment, rate limits for non-GET endpoints are set at 3000 requests per 10 minutes.

Example:3600
Bodyapplication/json
idstring, <= 50 characters(ResourceId)read-only

Unique resource ID.

Example:"4f6cf35x-2c4y-483z-a0a9-158621f77a21"
fileIdsArray of strings

IDs of linked file objects.

Uploaded identity-proof files must have the following tags attached to be used for KYC purposes: ['kyc', 'id-front'], ['kyc', 'id-back'], ['kyc', 'face-proof'].

Permitted file types for identity-proof files: .jpg, .png, and .pdf.

documentTypestring(StorefrontKycDocumentTypes)required

Document type submitted for validation. Only the identity-proof and address-proof types are analyzed automatically.

Enum:"identity-proof""address-proof""funds-proof""purchase-proof"
Discriminator
documentSubtypestring or null(KycDocumentSubtypes)

Document subtype submitted for validation.

Enum:"passport""id-card""driver-license""birth-certificate""utility-bill""rental-receipt""lease-agreement""copy-credit-card""credit-card-statement""bank-statement"
statusstringread-onlyrequired

Status of the validation.

Enum ValueDescription
pending

Waiting to be reviewed or analyzed.

in-progress

Being analyzed by the Rebilly AI.

accepted

Accepted by AI or a human.

rejected

Rejected by AI or a human.

archived

Archived by the Rebilly AI.

rejectionReasonobject or null(KycDocumentRejection)read-only

Reason the document is rejected.

requestIdstring or null, <= 50 charactersread-only

ID of the KYC request.

Example:"4f6cf35x-2c4y-483z-a0a9-158621f77a21"
createdTimestring, (date-time)(CreatedTime)read-only

Date and time when the resource is created. This value is set automatically when the resource is created.

updatedTimestring, (date-time)(UpdatedTime)read-only

Date and time when the resource is updated. This value is set automatically when the resource is updated.

processedTimestring, (date-time)read-only

Date and time when the KYC document is processed.

documentMatchesobject or nullread-only

Document matches.

Response
{
  "id": "4f6cf35x-2c4y-483z-a0a9-158621f77a21",
  "fileIds": [
    "4f6cf35x-2c4y-483z-a0a9-158621f77a21"
  ],
  "documentType": "identity-proof",
  "documentSubtype": "passport",
  "status": "pending",
  "rejectionReason": {
    "type": "document-unreadable",
    "message": "Provided document is unreadable"
  },
  "requestId": "4f6cf35x-2c4y-483z-a0a9-158621f77a21",
  "createdTime": "2019-08-24T14:15:22Z",
  "updatedTime": "2019-08-24T14:15:22Z",
  "processedTime": "2019-08-24T14:15:22Z",
  "documentMatches": {
    "version": "2.0",
    "data": { … }
  },
  "_links": [
    { … }
  ]
}