Skip to main content
PUT
/
account
/
{userId}
/
verification
/
{verificationId}
/
onboarding
cURL
curl --request PUT \
  --url https://staging-api.propaga.io/v1/account/{userId}/verification/{verificationId}/onboarding \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "step": "<string>",
  "document": {
    "fileExtension": "<string>",
    "base64Content": "<string>"
  },
  "information": {
    "cornerStoreType": "<string>",
    "businessLifetime": "<string>",
    "ownershipStatus": "<string>",
    "cornerStoreName": "<string>",
    "cornerStoreAddress": "<string>",
    "localeOwner": "<string>"
  }
}
'

Documentation Index

Fetch the complete documentation index at: https://docs.propaga.mx/llms.txt

Use this file to discover all available pages before exploring further.

​
Corner Store Onboarding

To onboard a corner store, this endpoint must be called. Before that, the create-verification use case must be invoked to obtain the verificationId required by this endpoint.

Create verification use case

Get more information about how call verification use-case

​
Important Considerations:

To send images to this endpoint, the base64 content of the image and its file extension must be provided. The optimal requirements for sending images are:
  • Clarity and Quality: Use clear, high-quality images without excessive shadows.
  • Positioning: The subject’s face should be centered and unobstructed by objects such as glasses, hats, or face masks. The entire face must be visible.
  • Size: The recommended image size is between 250 KB and 1 MB.
  • Format: We recommend using JPEG or PNG formats.
  • Colors: The image must be in color, not black and white.
  • Dimensions: The image should have a minimum width of 750 pixels.
  • Document Coverage (for INE): The document should cover at least 70% of the total image area.

​
How to Use This Endpoint

To use this endpoint, follow these steps:
  1. First, call the create-verification use case to obtain the verificationId.
  2. Next, use this endpoint to send the images and corner store information using the following request body example:
{
    "step": "DOCUMENT_IMAGE_FRONTAL",
    "document": {
        "fileExtension": "png",
        "base64Content": "base64 encoded content of the image"
    }
}
  1. Then, you need to call this endpoint again to send the information of the corner store, following the next body example:
{
    "step": "CORNER_STORE_INFORMATION",
    "information": {
        "cornerStoreType": "GROCERY_STORE",
        "businessLifetime": "LESS_THAN_ONE_YEAR",
        "ownershipStatus": "SOLE_PROPRIETOR",
        "cornerStoreName": "Corner store name",
        "cornerStoreAddress": "Corner store address",
        "localeOwner": "PROPIO"
    }
}
  1. Finally, you need to notify when user finished the onboarding, following the next body example:
{
    "step": "COMPLETED"
}

​
Path parameters

​
userId
string
required
Propaga’s user id
​
verificationId
string
required
Verification id generated when you call the create verification use-case

​
Body

​
step
string
default:"DOCUMENT_IMAGE_FRONTAL"
required
​
document
object
​
information
object