Sync app registration status (Sincronizar el estado de registro en la app)

Endpoint

POST - https://api.verifik.co/v2/app-registrations/{appRegistrationId}/sync

El endpoint App Registration Sync actualiza el estado y el paso de un proceso de registro de aplicación (App Registration). Este endpoint es útil para sincronizar el estado del registro, especialmente cuando se han cumplido condiciones o criterios específicos.

Headers

Include the necessary authentication headers, as well as any other headers required for authorization and content-type, such as:

Name	Value
Content-Type	application/json
Authorization	Bearer <token>

Body

Parameter	Type	Required	Description
step	String	Yes	Specifies the step to update, e.g., skipKYC.
status	String	Yes	The new status of the registration, e.g., COMPLETED_WITHOUT_KYC.

Step options

steps	statuses
skipKYC	COMPLETED_WITHOUT_KYC
instructions	ONGOING
signUpForm	ONGOING
basicInformation	ONGOING
document	ONGOING
liveness	ONGOING
form	ONGOING
end	[COMPLETED, FAILED, NEEDS_MANUAL_VERIFICATION]

Example Body

{
  "step": "skipKYC",
  "status": "COMPLETED_WITHOUT_KYC"
}

Request

cURL

curl -X PUT '{{developmentUrl}}/v2/app-registrations/{appRegistrationId}/sync' \
-H 'Authorization: Bearer <JWT_TOKEN>' \
-H 'Content-Type: application/json' \
-d '{
  "step": "skipKYC",
  "status": "COMPLETED_WITHOUT_KYC"
}'

Node.js

const axios = require('axios');

let data = JSON.stringify({
  "step": "skipKYC",
  "status": "COMPLETED_WITHOUT_KYC"
});

let config = {
  method: 'put',
  maxBodyLength: Infinity,
  url: '{{developmentUrl}}/v2/app-registrations/{appRegistrationId}/sync',
  headers: { 
    'Authorization': 'Bearer <JWT_TOKEN>', 
    'Content-Type': 'application/json'
  },
  data : data
};

axios.request(config)
.then((response) => {
  console.log(JSON.stringify(response.data));
})
.catch((error) => {
  console.log(error);
});

Swift

import Foundation

let url = URL(string: "{{developmentUrl}}/v2/app-registrations/{appRegistrationId}/sync")!
var request = URLRequest(url: url)
request.httpMethod = "PUT"
request.addValue("Bearer <JWT_TOKEN>", forHTTPHeaderField: "Authorization")
request.addValue("application/json", forHTTPHeaderField: "Content-Type")

let jsonData: [String: Any] = [
    "step": "skipKYC",
    "status": "COMPLETED_WITHOUT_KYC"
]
request.httpBody = try? JSONSerialization.data(withJSONObject: jsonData)

let task = URLSession.shared.dataTask(with: request) { data, response, error in
    guard let data = data, error == nil else {
        print("Error:", error ?? "Unknown error")
        return
    }
    if let httpResponse = response as? HTTPURLResponse, httpResponse.statusCode == 200 {
        print("Sync successful:", String(data: data, encoding: .utf8) ?? "")
    } else {
        print("Error:", String(data: data, encoding: .utf8) ?? "")
    }
}
task.resume()

Kotlin

import okhttp3.*
import org.json.JSONObject
import java.io.IOException

val client = OkHttpClient()

val json = JSONObject()
json.put("step", "skipKYC")
json.put("status", "COMPLETED_WITHOUT_KYC")

val requestBody = RequestBody.create(MediaType.parse("application/json; charset=utf-8"), json.toString())

val request = Request.Builder()
    .url("{{developmentUrl}}/v2/app-registrations/{appRegistrationId}/sync")
    .put(requestBody)
    .addHeader("Authorization", "Bearer <JWT_TOKEN>")
    .addHeader("Content-Type", "application/json")
    .build()

client.newCall(request).enqueue(object : Callback {
    override fun onFailure(call: Call, e: IOException) {
        e.printStackTrace()
    }

    override fun onResponse(call: Call, response: Response) {
        if (response.isSuccessful) {
            println("Sync successful: ${response.body()?.string()}")
        } else {
            println("Error: ${response.body()?.string()}")
        }
    }
})

Responses

200

{
  "data": {
    "token": "<JWT Token>",
    "firstName": "",
    "lastName": "",
    "fullName": "Carlos",
    "step": "signUpForm",
    "steps": {
      "signUpForm": "mandatory",
      "basicInformation": "skip",
      "document": "mandatory",
      "liveness": "mandatory",
      "form": "skip"
    },
    "appRegistrationId": "671ee3f2c96a3247fda5912",
    "status": "ONGOING"
  }
}

409

{ 
  "code": "Conflict",
  "message": "signUpForm_validation_not_passed"
}